Class _BaseComponent

The base component class that other components extend from.

Hierarchy (view full)

_BaseComponent

Index

Constructors

constructor

new _BaseComponent(key, client, options): _BaseComponent
Parameters
- key: string
- client: BetterClient
- options: BaseComponentOptions
Returns _BaseComponent
- Defined in packages/lib/src/classes/_BaseComponent.ts:52

Properties

`Readonly` authorOnly

authorOnly: boolean

Whether this component can only be used by the author of the interaction.

`Readonly` client

client: BetterClient

The client that instantiated this component.

`Private` `Optional` `Readonly` clientPermissions

clientPermissions?: PermissionsBitField

The permissions required from the application to run this component.

`Readonly` cooldown

cooldown: number

The cooldown of this component. This is in milliseconds.

`Optional` `Readonly` dmPermission

dmPermission?: boolean

Whether this component can be used in DMs.

`Private` `Readonly` guildOnly

guildOnly: boolean

Whether this component can only be used in guilds.

`Readonly` key

key: string

The key of this component. This is used to identify the component, and is usually used as the custom ID or the command name.

`Private` `Readonly` ownerOnly

ownerOnly: boolean

Whether this component can only be used by the owner of the guild.

`Optional` `Readonly` permissions

permissions?: PermissionsBitField

The permissions required from the user to run this component.

`Private` `Optional` `Readonly` restriction

restriction?: string

The access role required to run this component.

Methods

run

run(interaction): Promise<any>
Parameters
- interaction: BaseInteraction<CacheType>
Returns Promise<any>
- Defined in packages/lib/src/classes/_BaseComponent.ts:150

specificValidate

specificValidate(_interaction): Promise<null | APIEmbed>
Parameters
- _interaction: BaseInteraction<CacheType>
Returns Promise<null | APIEmbed>
- Defined in packages/lib/src/classes/_BaseComponent.ts:144

validate

validate(interaction): Promise<null | APIEmbed>
Parameters
- interaction: BaseInteraction<CacheType>
Returns Promise<null | APIEmbed>
- Defined in packages/lib/src/classes/_BaseComponent.ts:70

Class _BaseComponent

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns _BaseComponent

Properties

`Readonly` authorOnly

`Readonly` client

`Private` `Optional` `Readonly` clientPermissions

`Readonly` cooldown

`Optional` `Readonly` dmPermission

`Private` `Readonly` guildOnly

`Readonly` key

`Private` `Readonly` ownerOnly

`Optional` `Readonly` permissions

`Private` `Optional` `Readonly` restriction

Methods

run

Parameters

Returns Promise<any>

specificValidate

Parameters

Returns Promise<null | APIEmbed>

validate

Parameters

Returns Promise<null | APIEmbed>

Settings

Member Visibility

Theme

On This Page

Class _BaseComponent

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns _BaseComponent

Properties

Readonly authorOnly

Readonly client

Private Optional Readonly clientPermissions

Readonly cooldown

Optional Readonly dmPermission

Private Readonly guildOnly

Readonly key

Private Readonly ownerOnly

Optional Readonly permissions

Private Optional Readonly restriction

Methods

run

Parameters

Returns Promise<any>

specificValidate

Parameters

Returns Promise<null | APIEmbed>

validate

Parameters

Returns Promise<null | APIEmbed>

Settings

Member Visibility

Theme

On This Page

`Readonly` authorOnly

`Readonly` client

`Private` `Optional` `Readonly` clientPermissions

`Readonly` cooldown

`Optional` `Readonly` dmPermission

`Private` `Readonly` guildOnly

`Readonly` key

`Private` `Readonly` ownerOnly

`Optional` `Readonly` permissions

`Private` `Optional` `Readonly` restriction