talawa-api / Exports / helpers/event/updateEventHelpers/updateAllInstances
Module: helpers/event/updateEventHelpers/updateAllInstances
Table of contents
Functions
Functions
updateAllInstances
▸ updateAllInstances(args
, event
, recurrenceRule
, baseRecurringEvent
, session
): Promise
<InterfaceEvent
>
This function updates all instances of the recurring event following the given recurrenceRule.
Parameters
Name | Type | Description |
---|---|---|
args | MutationUpdateEventArgs | update event args. |
event | InterfaceEvent | the event to be updated. |
recurrenceRule | InterfaceRecurrenceRule | the recurrence rule followed by the instances. |
baseRecurringEvent | InterfaceEvent | the base recurring event. |
session | ClientSession | - |
Returns
Promise
<InterfaceEvent
>
The updated event.
Remarks
The following steps are followed:
- get the current event data.
- update the data provided in the input.
Defined in
src/helpers/event/updateEventHelpers/updateAllInstances.ts:20