Class Components

Utils Components Structure

Hierarchy

Structure
- Components

Index

Constructors

constructor

Properties

Constructors

constructor

new Components(data?: ComponentsOptions): Components

Overrides Structure.constructor
- Defined in src/utils/components/components.ts:50
Parameters
- data: ComponentsOptions = {}
Returns Components

Properties

Readonly _keys

_keys: BaseSet<string> = ...

Optional _timeout

_timeout: Timeout

components

components: ComponentActionRow[] = []

Optional id

id: string

timeout

timeout: number = ...

Methods

[custom]

[custom](): object

Inherited from Structure.[custom]
- Defined in src/structures/basestructure.ts:282
Returns object

_getFromSnake

_getFromSnake(key: string): any

Inherited from Structure._getFromSnake
- Defined in src/structures/basestructure.ts:33
Parameters
- key: string
Returns any

_setFromSnake

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

Inherited from Structure._setFromSnake
- Defined in src/structures/basestructure.ts:37
Parameters
- key: string
- value: any
Returns any

addActionRow

addActionRow(data?: ComponentActionRowData | ComponentActionRow): Components

- Defined in src/utils/components/components.ts:60
Parameters
- data: ComponentActionRowData | ComponentActionRow = {}
Returns Components

addButton

addButton(data?: ComponentActionData | ComponentButton, inline?: boolean): Components

- Defined in src/utils/components/components.ts:69
Parameters
- data: ComponentActionData | ComponentButton = {}
- inline: boolean = true
Returns Components

addSelectMenu

addSelectMenu(data?: ComponentActionData | ComponentSelectMenu): Components

- Defined in src/utils/components/components.ts:80
Parameters
- data: ComponentActionData | ComponentSelectMenu = {}
Returns Components

createActionRow

createActionRow(data?: ComponentActionRowData): ComponentActionRow

- Defined in src/utils/components/components.ts:86
Parameters
- data: ComponentActionRowData = {}
Returns ComponentActionRow

createButton

createButton(data?: ComponentActionData, inline?: boolean): ComponentButton

- Defined in src/utils/components/components.ts:92
Parameters
- data: ComponentActionData = {}
- inline: boolean = true
Returns ComponentButton

createSelectMenu

createSelectMenu(data?: ComponentActionData): ComponentSelectMenu

- Defined in src/utils/components/components.ts:102
Parameters
- data: ComponentActionData = {}
Returns ComponentSelectMenu

difference

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

Inherited from Structure.difference
- Defined in src/structures/basestructure.ts:41
Parameters
- key: string
- value: any
Returns [boolean, any]

differences

differences(data?: BaseStructureData): null | object

Inherited from Structure.differences
- Defined in src/structures/basestructure.ts:67
Parameters
- Optional data: BaseStructureData
Returns null | object

differencesBetween

differencesBetween(structure: Structure): null | object

Inherited from Structure.differencesBetween
- Defined in src/structures/basestructure.ts:86
Parameters
- structure: Structure
Returns null | object

hasDifference

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

Inherited from Structure.hasDifference
- Defined in src/structures/basestructure.ts:107
Parameters
- key: string
- value: any
Returns boolean

hasDifferences

hasDifferences(data?: BaseStructureData): boolean

Inherited from Structure.hasDifferences
- Defined in src/structures/basestructure.ts:195
Parameters
- Optional data: BaseStructureData
Returns boolean

hasDifferencesBetween

hasDifferencesBetween(structure: Structure): boolean

Inherited from Structure.hasDifferencesBetween
- Defined in src/structures/basestructure.ts:210
Parameters
- structure: Structure
Returns boolean

merge

merge(data?: BaseStructureData): void

Inherited from Structure.merge
- Defined in src/structures/basestructure.ts:225
Parameters
- Optional data: BaseStructureData
Returns void

mergeValue

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

Overrides Structure.mergeValue
- Defined in src/utils/components/components.ts:107
Parameters
- key: string
- value: any
Returns void

Optional onError

onError(context: ComponentContext, error: Error): any

- Defined in src/utils/components/components.ts:50
Parameters
- context: ComponentContext
- error: Error
Returns any

Optional onTimeout

onTimeout(): any

- Defined in src/utils/components/components.ts:48
Returns any

Optional run

run(context: ComponentContext): any

- Defined in src/utils/components/components.ts:49
Parameters
- context: ComponentContext
Returns any

toJSON

toJSON(): RawChannelMessageComponent[]

Overrides Structure.toJSON
- Defined in src/utils/components/components.ts:131
Returns RawChannelMessageComponent[]

Generated using TypeDoc