Skip to main content

Class: Enabled

CorePreconditions.Enabled

Hierarchy

Constructors

constructor

new Enabled(context)

Parameters

NameType
contextPieceContext

Overrides

AllFlowsPrecondition.constructor

Defined in

projects/framework/src/preconditions/Enabled.ts:8

Properties

enabled

enabled: boolean

Whether or not the piece is enabled.

Inherited from

AllFlowsPrecondition.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

AllFlowsPrecondition.location

Defined in

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


name

Readonly name: string

The name of the piece.

Inherited from

AllFlowsPrecondition.name

Defined in

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


options

Readonly options: PreconditionOptions

The raw options passed to this Piece

Inherited from

AllFlowsPrecondition.options

Defined in

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


position

Readonly position: null | number

Inherited from

AllFlowsPrecondition.position

Defined in

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


store

Readonly store: Store<Piece<PieceOptions>>

The store that contains the piece.

Inherited from

AllFlowsPrecondition.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

AllFlowsPrecondition.container

Defined in

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

Methods

chatInputRun

chatInputRun(_, command, context): PreconditionResult

Parameters

NameType
_CommandInteraction<CacheType>
commandCommand<Args, CommandOptions>
contextPreconditionContext

Returns

PreconditionResult

Overrides

AllFlowsPrecondition.chatInputRun

Defined in

projects/framework/src/preconditions/Enabled.ts:18


contextMenuRun

contextMenuRun(_, command, context): PreconditionResult

Parameters

NameType
_ContextMenuInteraction<CacheType>
commandCommand<Args, CommandOptions>
contextPreconditionContext

Returns

PreconditionResult

Overrides

AllFlowsPrecondition.contextMenuRun

Defined in

projects/framework/src/preconditions/Enabled.ts:24


error

error(options?): PreconditionResult

Constructs a PreconditionError with the precondition parameter set to this.

Parameters

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

Returns

PreconditionResult

Inherited from

AllFlowsPrecondition.error

Defined in

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


fetchChannelFromInteraction

Protected fetchChannelFromInteraction(interaction): Promise<TextBasedChannel>

Parameters

NameType
interactionBaseCommandInteraction<CacheType>

Returns

Promise<TextBasedChannel>

Inherited from

AllFlowsPrecondition.fetchChannelFromInteraction

Defined in

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


messageRun

messageRun(_, command, context): PreconditionResult

Parameters

NameType
_Message<boolean>
commandCommand<Args, CommandOptions>
contextPreconditionContext

Returns

PreconditionResult

Overrides

AllFlowsPrecondition.messageRun

Defined in

projects/framework/src/preconditions/Enabled.ts:12


ok

ok(): PreconditionResult

Returns

PreconditionResult

Inherited from

AllFlowsPrecondition.ok

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

AllFlowsPrecondition.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

AllFlowsPrecondition.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

AllFlowsPrecondition.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

AllFlowsPrecondition.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

AllFlowsPrecondition.unload

Defined in

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