Skip to main content

Class: Precondition<O>

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:16

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:447


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:439


name

Readonly name: string

The name of the piece.

Inherited from

Piece.name

Defined in

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


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:451


position

Readonly position: null | number

Defined in

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


store

Readonly store: Store<Piece<PieceOptions>>

The store that contains the piece.

Inherited from

Piece.store

Defined in

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

Accessors

container

get container(): Container

A reference to the {@link Container} object for ease of use.

see container

Returns

Container

Inherited from

Piece.container

Defined in

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

Methods

chatInputRun

Optional chatInputRun(interaction, command, context): PreconditionResult

Parameters

NameType
interactionCommandInteraction<CacheType>
commandChatInputCommand
contextPreconditionContext

Returns

PreconditionResult

Defined in

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


contextMenuRun

Optional contextMenuRun(interaction, command, context): PreconditionResult

Parameters

NameType
interactionContextMenuInteraction<CacheType>
commandContextMenuCommand
contextPreconditionContext

Returns

PreconditionResult

Defined in

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


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:35


fetchChannelFromInteraction

Protected fetchChannelFromInteraction(interaction): Promise<TextBasedChannel>

Parameters

NameType
interactionBaseCommandInteraction<CacheType>

Returns

Promise<TextBasedChannel>

Defined in

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


messageRun

Optional messageRun(message, command, context): PreconditionResult

Parameters

NameType
messageMessage<boolean>
commandMessageCommand
contextPreconditionContext

Returns

PreconditionResult

Defined in

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


ok

ok(): PreconditionResult

Returns

PreconditionResult

Defined in

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


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:462


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:467


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:475


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:479


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:471