Skip to main content

ScheduledEventRecurrenceRule

Documentation


Documentation / @discordeno/bot / ScheduledEventRecurrenceRule

Interface: ScheduledEventRecurrenceRule

Defined in: transformers/types.ts:1675

Properties

byMonth

byMonth: DiscordScheduledEventRecurrenceRuleMonth[] | null

Defined in: transformers/types.ts:1689

Set of specific months to recur on


byMonthDay

byMonthDay: number[] | null

Defined in: transformers/types.ts:1691

Set of specific dates within a month to recur on


byNWeekday

byNWeekday: DiscordScheduledEventRecurrenceRuleNWeekday[] | null

Defined in: transformers/types.ts:1687

List of specific days within a specific week (1-5) to recur on


byWeekday

byWeekday: DiscordScheduledEventRecurrenceRuleWeekday[] | null

Defined in: transformers/types.ts:1685

Set of specific days within a week for the event to recur on


byYearDay

byYearDay: number[] | null

Defined in: transformers/types.ts:1693

Set of days within a year to recur on (1-364)


count

count: number | null

Defined in: transformers/types.ts:1695

The total amount of times that the event is allowed to recur before stopping


end

end: number | null

Defined in: transformers/types.ts:1679

Ending time of the recurrence interval


frequency

frequency: DiscordScheduledEventRecurrenceRuleFrequency

Defined in: transformers/types.ts:1681

How often the event occurs


interval

interval: number

Defined in: transformers/types.ts:1683

The spacing between the events, defined by frequency. For example, frequency of Weekly and an interval of 2 would be "every-other week"


start

start: number

Defined in: transformers/types.ts:1677

Starting time of the recurrence interval