Class: AllFlowsPrecondition

The piece to be stored in Store instances.

Hierarchy

• Precondition

  ↳ AllFlowsPrecondition

Constructors

constructor

• new AllFlowsPrecondition(context, options?): AllFlowsPrecondition

Parameters

Name	Type
context	LoaderContext
options	PreconditionOptions

Returns

AllFlowsPrecondition

Inherited from

Precondition.constructor

Defined in

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

Properties

enabled

• enabled: boolean

Whether or not the piece is enabled.

Inherited from

Precondition.enabled

Defined in

node_modules/@sapphire/pieces/dist/esm/index.d.mts:234

---

location

• Readonly location: PieceLocation

The location metadata for the piece's file.

Inherited from

Precondition.location

Defined in

node_modules/@sapphire/pieces/dist/esm/index.d.mts:226

---

name

• Readonly name: string

The name of the piece.

Inherited from

Precondition.name

Defined in

node_modules/@sapphire/pieces/dist/esm/index.d.mts:230

---

options

• Readonly options: PreconditionOptions

The raw options passed to this Piece

Inherited from

Precondition.options

Defined in

node_modules/@sapphire/pieces/dist/esm/index.d.mts:238

---

position

• Readonly position: null | number

Inherited from

Precondition.position

Defined in

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

---

store

• Readonly store: PreconditionStore

The store that contains the piece.

Inherited from

Precondition.store

Defined in

node_modules/@sapphire/pieces/dist/esm/index.d.mts:222

Accessors

container

• get container(): Container

A reference to the Container object for ease of use.

Returns

Container

See

container

Inherited from

Precondition.container

Defined in

node_modules/@sapphire/pieces/dist/esm/index.d.mts:244

Methods

chatInputRun

▸ chatInputRun(interaction, command, context): PreconditionResult

Parameters

Name	Type
interaction	ChatInputCommandInteraction<CacheType>
command	ChatInputCommand
context	PreconditionContext

Returns

PreconditionResult

Overrides

Precondition.chatInputRun

Defined in

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

---

contextMenuRun

▸ contextMenuRun(interaction, command, context): PreconditionResult

Parameters

Name	Type
interaction	ContextMenuCommandInteraction<CacheType>
command	ContextMenuCommand
context	PreconditionContext

Returns

PreconditionResult

Overrides

Precondition.contextMenuRun

Defined in

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

---

error

▸ error(options?): PreconditionResult

Constructs a PreconditionError with the precondition parameter set to this.

Parameters

Name	Type	Description
options	Omit<Options, "precondition">	The information.

Returns

PreconditionResult

Inherited from

Precondition.error

Defined in

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

---

fetchChannelFromInteraction

▸ fetchChannelFromInteraction(interaction): Promise<TextBasedChannel>

Parameters

Name	Type
interaction	CommandInteraction<CacheType>

Returns

Promise<TextBasedChannel>

Inherited from

Precondition.fetchChannelFromInteraction

Defined in

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

---

messageRun

▸ messageRun(message, command, context): PreconditionResult

Parameters

Name	Type
message	Message<boolean>
command	MessageCommand
context	PreconditionContext

Returns

PreconditionResult

Overrides

Precondition.messageRun

Defined in

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

---

ok

▸ ok(): PreconditionResult

Returns

PreconditionResult

Inherited from

Precondition.ok

Defined in

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

---

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

Precondition.onLoad

Defined in

node_modules/@sapphire/pieces/dist/esm/index.d.mts:249

---

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

Precondition.onUnload

Defined in

node_modules/@sapphire/pieces/dist/esm/index.d.mts:254

---

reload

▸ reload(): Promise<void>

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

Returns

Promise<void>

Inherited from

Precondition.reload

Defined in

node_modules/@sapphire/pieces/dist/esm/index.d.mts:262

---

toJSON

▸ toJSON(): PieceJSON

Defines the JSON.stringify behavior of this piece.

Returns

PieceJSON

Inherited from

Precondition.toJSON

Defined in

node_modules/@sapphire/pieces/dist/esm/index.d.mts:266

---

unload

▸ unload(): Promise<void>

Unloads and disables the piece.

Returns

Promise<void>

Inherited from

Precondition.unload

Defined in

node_modules/@sapphire/pieces/dist/esm/index.d.mts:258