Preview environment

interface GuildScheduledEventRecurrenceRule

export interface GuildScheduledEventRecurrenceRule

Represents the recurrence rule for a GuildScheduledEvent.

byMonth : readonly GuildScheduledEventRecurrenceRuleMonth[] | null

The months to recur on

byMonthDay : readonly number[] | null

The days within a month to recur on

byNWeekday : readonly GuildScheduledEventRecurrenceRuleNWeekday[] | null

The days within a week to recur on

byWeekday : readonly GuildScheduledEventRecurrenceRuleWeekday[] | null

The days within a week to recur on

byYearDay : readonly number[] | null

The days within a year to recur on

count : number | null

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

readonly
endAt : Date | null

The time the recurrence rule interval ends at

endTimestamp : number | null

The timestamp the recurrence rule interval ends at

frequency : GuildScheduledEventRecurrenceRuleFrequency

How often the event occurs

interval : number

The spacing between the events

readonly
startAt : Date

The time the recurrence rule interval starts at

startTimestamp : number

The timestamp the recurrence rule interval starts at