Skip to main content

Class: Precondition<O>

The piece to be stored in Store instances.

Type parameters

NameType
Oextends Options = Options

Hierarchy

Constructors

constructor

new Precondition<O>(context, options?)

Type parameters

NameType
Oextends PreconditionOptions<O> = PreconditionOptions

Parameters

NameType
contextPieceContext
optionsPreconditionOptions

Overrides

Piece.constructor

Defined in

projects/framework/src/lib/structures/Precondition.ts:29

Properties

enabled

enabled: boolean

Whether or not the piece is enabled.

Inherited from

Piece.enabled

Defined in

node_modules/@sapphire/pieces/dist/index.d.ts:450


location

Readonly location: PieceLocation

The location metadata for the piece's file.

Inherited from

Piece.location

Defined in

node_modules/@sapphire/pieces/dist/index.d.ts:442


name

Readonly name: string

The name of the piece.

Inherited from

Piece.name

Defined in

node_modules/@sapphire/pieces/dist/index.d.ts:446


options

Readonly options: O

The raw options passed to this Piece

Inherited from

Piece.options

Defined in

node_modules/@sapphire/pieces/dist/index.d.ts:454


position

Readonly position: null | number

Defined in

projects/framework/src/lib/structures/Precondition.ts:27


store

store: PreconditionStore

The PreconditionStore that contains this Precondition.

Overrides

Piece.store

Defined in

projects/framework/src/lib/structures/Precondition.ts:25

Accessors

container

get container(): Container

A reference to the Container object for ease of use.

See

container

Returns

Container

Inherited from

Piece.container

Defined in

node_modules/@sapphire/pieces/dist/index.d.ts:460

Methods

chatInputRun

Optional chatInputRun(interaction, command, context): PreconditionResult

Parameters

NameType
interactionChatInputCommandInteraction<CacheType>
commandChatInputCommand
contextPreconditionContext

Returns

PreconditionResult

Defined in

projects/framework/src/lib/structures/Precondition.ts:36


contextMenuRun

Optional contextMenuRun(interaction, command, context): PreconditionResult

Parameters

NameType
interactionContextMenuCommandInteraction<CacheType>
commandContextMenuCommand
contextPreconditionContext

Returns

PreconditionResult

Defined in

projects/framework/src/lib/structures/Precondition.ts:38


error

error(options?): PreconditionResult

Constructs a PreconditionError with the precondition parameter set to this.

Parameters

NameTypeDescription
optionsOmit<Options, "precondition">The information.

Returns

PreconditionResult

Defined in

projects/framework/src/lib/structures/Precondition.ts:52


fetchChannelFromInteraction

Protected fetchChannelFromInteraction(interaction): Promise<TextBasedChannel>

Parameters

NameType
interactionCommandInteraction<CacheType>

Returns

Promise<TextBasedChannel>

Defined in

projects/framework/src/lib/structures/Precondition.ts:56


messageRun

Optional messageRun(message, command, context): PreconditionResult

Parameters

NameType
messageMessage<boolean>
commandMessageCommand
contextPreconditionContext

Returns

PreconditionResult

Defined in

projects/framework/src/lib/structures/Precondition.ts:34


ok

ok(): PreconditionResult

Returns

PreconditionResult

Defined in

projects/framework/src/lib/structures/Precondition.ts:44


onLoad

onLoad(): unknown

Per-piece listener that is called when the piece is loaded into the store. Useful to set-up asynchronous initialization tasks.

Returns

unknown

Inherited from

Piece.onLoad

Defined in

node_modules/@sapphire/pieces/dist/index.d.ts:465


onUnload

onUnload(): unknown

Per-piece listener that is called when the piece is unloaded from the store. Useful to set-up clean-up tasks.

Returns

unknown

Inherited from

Piece.onUnload

Defined in

node_modules/@sapphire/pieces/dist/index.d.ts:470


reload

reload(): Promise<void>

Reloads the piece by loading the same path in the store.

Returns

Promise<void>

Inherited from

Piece.reload

Defined in

node_modules/@sapphire/pieces/dist/index.d.ts:478


toJSON

toJSON(): PieceJSON

Defines the JSON.stringify behavior of this piece.

Returns

PieceJSON

Inherited from

Piece.toJSON

Defined in

node_modules/@sapphire/pieces/dist/index.d.ts:482


unload

unload(): Promise<void>

Unloads and disables the piece.

Returns

Promise<void>

Inherited from

Piece.unload

Defined in

node_modules/@sapphire/pieces/dist/index.d.ts:474