Class: Precondition<O>
Type parameters​
| Name | Type |
|---|---|
O | extends Options = Options |
Hierarchy​
Piece<O>↳
Precondition↳↳
AllFlowsPrecondition
Constructors​
constructor​
• new Precondition<O>(context, options?)
Type parameters​
| Name | Type |
|---|---|
O | extends PreconditionOptions<O> = PreconditionOptions |
Parameters​
| Name | Type |
|---|---|
context | PieceContext |
options | PreconditionOptions |
Overrides​
Defined in​
projects/framework/src/lib/structures/Precondition.ts:16
Properties​
enabled​
• enabled: boolean
Whether or not the piece is enabled.
Inherited from​
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​
Defined in​
node_modules/@sapphire/pieces/dist/index.d.ts:439
name​
• Readonly name: string
The name of the piece.
Inherited from​
Defined in​
node_modules/@sapphire/pieces/dist/index.d.ts:443
options​
• Readonly options: O
The raw options passed to this Piece
Inherited from​
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​
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​
| Name | Type |
|---|---|
interaction | CommandInteraction<CacheType> |
command | ChatInputCommand |
context | PreconditionContext |
Returns​
Defined in​
projects/framework/src/lib/structures/Precondition.ts:23
contextMenuRun​
â–¸ Optional contextMenuRun(interaction, command, context): PreconditionResult
Parameters​
| Name | Type |
|---|---|
interaction | ContextMenuInteraction<CacheType> |
command | ContextMenuCommand |
context | PreconditionContext |
Returns​
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​
| Name | Type | Description |
|---|---|---|
options | Omit<Options, "precondition"> | The information. |
Returns​
Defined in​
projects/framework/src/lib/structures/Precondition.ts:35
fetchChannelFromInteraction​
â–¸ Protected fetchChannelFromInteraction(interaction): Promise<TextBasedChannel>
Parameters​
| Name | Type |
|---|---|
interaction | BaseCommandInteraction<CacheType> |
Returns​
Promise<TextBasedChannel>
Defined in​
projects/framework/src/lib/structures/Precondition.ts:39
messageRun​
â–¸ Optional messageRun(message, command, context): PreconditionResult
Parameters​
| Name | Type |
|---|---|
message | Message<boolean> |
command | MessageCommand |
context | PreconditionContext |
Returns​
Defined in​
projects/framework/src/lib/structures/Precondition.ts:21
ok​
â–¸ ok(): PreconditionResult
Returns​
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​
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​
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​
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​
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​
Defined in​
node_modules/@sapphire/pieces/dist/index.d.ts:471