Skip to main content
Module

x/discord_api_types/payloads/v10/guildScheduledEvent.ts>APIGuildScheduledEventRecurrenceRule

Up to date Discord API Typings, versioned by the API version
discordjs/discord-api-types
Popular
Go to Latest
interface APIGuildScheduledEventRecurrenceRule
import { type APIGuildScheduledEventRecurrenceRule } from "https://deno.land/x/discord_api_types@0.37.98/payloads/v10/guildScheduledEvent.ts";

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

Properties

start: string

Starting time of the recurrence interval

end: string | null

Ending time of the recurrence interval

frequency: GuildScheduledEventRecurrenceRuleFrequency

How often the event occurs

interval: number

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

by_weekday: GuildScheduledEventRecurrenceRuleWeekday[] | null

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

by_n_weekday: GuildScheduledEventRecurrenceRuleNWeekday[] | null

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

by_month: GuildScheduledEventRecurrenceRuleMonth[] | null

Set of specific months to recur on

by_month_day: number[] | null

Set of specific dates within a month to recur on

by_year_day: number[] | null

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

count: number | null

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