Skip to main content

DiscordScheduledEventRecurrenceRule

@discordeno/botDocs


Documentation / @discordeno/bot / DiscordScheduledEventRecurrenceRule

Interface: DiscordScheduledEventRecurrenceRule

Properties

by_month

by_month: null | DiscordScheduledEventRecurrenceRuleMonth[]

Set of specific months to recur on

Defined in

packages/types/dist/types/discord.d.ts:2302


by_month_day

by_month_day: null | number[]

Set of specific dates within a month to recur on

Defined in

packages/types/dist/types/discord.d.ts:2304


by_n_weekday

by_n_weekday: null | DiscordScheduledEventRecurrenceRuleNWeekday[]

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

Defined in

packages/types/dist/types/discord.d.ts:2300


by_weekday

by_weekday: null | DiscordScheduledEventRecurrenceRuleWeekday[]

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

Defined in

packages/types/dist/types/discord.d.ts:2298


by_year_day

by_year_day: null | number[]

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

Defined in

packages/types/dist/types/discord.d.ts:2306


count

count: null | number

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

Defined in

packages/types/dist/types/discord.d.ts:2308


end

end: null | string

Ending time of the recurrence interval

Defined in

packages/types/dist/types/discord.d.ts:2292


frequency

frequency: DiscordScheduledEventRecurrenceRuleFrequency

How often the event occurs

Defined in

packages/types/dist/types/discord.d.ts:2294


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/types/dist/types/discord.d.ts:2296


start

start: string

Starting time of the recurrence interval

Defined in

packages/types/dist/types/discord.d.ts:2290