Skip to main content

talawa-api / Exports / helpers/event/recurringEventHelpers/generateRecurrenceRuleString

Module: helpers/event/recurringEventHelpers/generateRecurrenceRuleString

Table of contents

Functions

Functions

generateRecurrenceRuleString

generateRecurrenceRuleString(recurrenceRuleData, recurrenceStartDate, recurrenceEndDate?): string

This function generates the recurrence rule (rrule) string.

Parameters

NameTypeDescription
recurrenceRuleDataRecurrenceRuleInputthe recurrenceRuleInput provided in the args.
recurrenceStartDateDatestart date of recurrence.
recurrenceEndDate?Dateend date of recurrence.

Returns

string

The recurrence rule string that would be used to create a valid rrule object.

Remarks

The following steps are followed:

  1. Get the date strings for start and end of recurrence.
  2. Get the recurrence rules and make a recurrenceRuleString.

Defined in

src/helpers/event/recurringEventHelpers/generateRecurrenceRuleString.ts:16