Skip to main content

DiscordScheduledEventRecurrenceRule

Documentation

Documentation / @discordeno/types / DiscordScheduledEventRecurrenceRule

Interface: DiscordScheduledEventRecurrenceRule

Defined in: discord/guildScheduledEvent.ts:82

https://docs.discord.com/developers/resources/guild-scheduled-event#guild-scheduled-event-recurrence-rule-object-guild-scheduled-event-recurrence-rule-structure

Properties​

by_month​

by_month: DiscordScheduledEventRecurrenceRuleMonth[] | null

Defined in: discord/guildScheduledEvent.ts:96

Set of specific months to recur on

by_month_day​

by_month_day: number[] | null

Defined in: discord/guildScheduledEvent.ts:98

Set of specific dates within a month to recur on

by_n_weekday​

by_n_weekday: DiscordScheduledEventRecurrenceRuleNWeekday[] | null

Defined in: discord/guildScheduledEvent.ts:94

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

by_weekday​

by_weekday: DiscordScheduledEventRecurrenceRuleWeekday[] | null

Defined in: discord/guildScheduledEvent.ts:92

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

by_year_day​

by_year_day: number[] | null

Defined in: discord/guildScheduledEvent.ts:100

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

count​

count: number | null

Defined in: discord/guildScheduledEvent.ts:102

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

end​

end: string | null

Defined in: discord/guildScheduledEvent.ts:86

Ending time of the recurrence interval

frequency​

frequency: DiscordScheduledEventRecurrenceRuleFrequency

Defined in: discord/guildScheduledEvent.ts:88

How often the event occurs

interval​

interval: number

Defined in: discord/guildScheduledEvent.ts:90

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: string

Defined in: discord/guildScheduledEvent.ts:84

Starting time of the recurrence interval