Skip to main content

ScheduledEventRecurrenceRule

@discordeno/botDocs


Documentation / @discordeno/bot / ScheduledEventRecurrenceRule

Interface: ScheduledEventRecurrenceRule

Properties

byMonth

byMonth: null | DiscordScheduledEventRecurrenceRuleMonth[]

Set of specific months to recur on

Defined in

packages/bot/src/transformers/types.ts:1528


byMonthDay

byMonthDay: null | number[]

Set of specific dates within a month to recur on

Defined in

packages/bot/src/transformers/types.ts:1530


byNWeekday

byNWeekday: null | DiscordScheduledEventRecurrenceRuleNWeekday[]

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

Defined in

packages/bot/src/transformers/types.ts:1526


byWeekday

byWeekday: null | DiscordScheduledEventRecurrenceRuleWeekday[]

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

Defined in

packages/bot/src/transformers/types.ts:1524


byYearDay

byYearDay: null | number[]

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

Defined in

packages/bot/src/transformers/types.ts:1532


count

count: null | number

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

Defined in

packages/bot/src/transformers/types.ts:1534


end

end: null | number

Ending time of the recurrence interval

Defined in

packages/bot/src/transformers/types.ts:1518


frequency

frequency: DiscordScheduledEventRecurrenceRuleFrequency

How often the event occurs

Defined in

packages/bot/src/transformers/types.ts:1520


interval

interval: number

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

Defined in

packages/bot/src/transformers/types.ts:1522


start

start: number

Starting time of the recurrence interval

Defined in

packages/bot/src/transformers/types.ts:1516