Documentation/detritus-client/Structures

GuildScheduledEventRecurrenceRuleclass

Guild Scheduled Event Recurrence Rule Structure

On this page

Overview
Constructor1
Properties11
Accessors4
Methods13

Guild Scheduled Event Recurrence Rule Structure

import { Structures } from 'detritus-client';

Structures.GuildScheduledEventRecurrenceRule;

Hierarchy

StructureBaseStructureGuildScheduledEventRecurrenceRule

12 properties16 inheritedsrc/structures/guildscheduledevent.ts:286

Constructor

new GuildScheduledEventRecurrenceRule

src/structures/guildscheduledevent.ts:300

new GuildScheduledEventRecurrenceRule(
  client: ShardClient,
  data?: BaseStructureData,
  isClone?: boolean,
)

Properties

byMonth

GuildScheduledEventRecurrenceRuleMonths[] | null

Default null

byMonthDay

number[] | null

Default null

byNWeekday

{ day: GuildScheduledEventRecurrenceRuleWeekdays; n: number }[] | null

Default null

byWeekday

GuildScheduledEventRecurrenceRuleWeekdays[] | null

Default null

byYearDay

number[] | null

Default null

client

ShardClient

readonly

Inherited from BaseStructure.client

count

number | null

Default null

end

string | null

Default null

frequency

GuildScheduledEventRecurrenceRuleFrequencies

Default GuildScheduledEventRecurrenceRuleFrequencies.WEEKLY

interval

number

Default 1

start

string

Default ''

Accessors

endAt

Date | null

get

isClone

boolean

get

Inherited from BaseStructure.isClone

shardId

number

get

Inherited from BaseStructure.shardId

startAt

Date

get

Methods

_getFromSnake()

src/structures/basestructure.ts:138

_getFromSnake(key: string): any

Inherited from BaseStructure._getFromSnake

_setFromSnake()

src/structures/basestructure.ts:142

_setFromSnake(key: string, value: any): any

Inherited from BaseStructure._setFromSnake

[custom]()

src/structures/basestructure.ts:388

[custom](): object

Inherited from BaseStructure.[custom]

clone()

src/structures/basestructure.ts:431

clone(): this

Inherited from BaseStructure.clone

difference()

src/structures/basestructure.ts:146

difference(key: string, value: any): [boolean, any]

Inherited from BaseStructure.difference

differences()

src/structures/basestructure.ts:178

differences(data?: BaseStructureData): object | null

Inherited from BaseStructure.differences

differencesBetween()

src/structures/basestructure.ts:197

differencesBetween(structure: Structure): object | null

Inherited from BaseStructure.differencesBetween

hasDifference()

src/structures/basestructure.ts:218

hasDifference(key: string, value: any): boolean

Inherited from BaseStructure.hasDifference

hasDifferences()

src/structures/basestructure.ts:293

hasDifferences(data?: BaseStructureData): boolean

Inherited from BaseStructure.hasDifferences

hasDifferencesBetween()

src/structures/basestructure.ts:308

hasDifferencesBetween(structure: Structure): boolean

Inherited from BaseStructure.hasDifferencesBetween

merge()

src/structures/basestructure.ts:323

merge(data?: BaseStructureData): void

Inherited from BaseStructure.merge

mergeValue()

src/structures/basestructure.ts:351

mergeValue(key: string, value: any): void

Inherited from BaseStructure.mergeValue

toJSON()

src/structures/basestructure.ts:357

toJSON(): object

Inherited from BaseStructure.toJSON