Skip to main content

Class: GuildThreadOnly

CorePreconditions.GuildThreadOnly

Hierarchy

Constructors

constructor

โ€ข new GuildThreadOnly(context, options?)

Parameters

NameType
contextPieceContext
optionsPreconditionOptions

Inherited from

Precondition.constructor

Defined in

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

Properties

enabled

โ€ข enabled: boolean

Whether or not the piece is enabled.

Inherited from

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

Precondition.location

Defined in

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


name

โ€ข Readonly name: string

The name of the piece.

Inherited from

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

Precondition.options

Defined in

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


position

โ€ข Readonly position: null | number

Inherited from

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

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

Precondition.container

Defined in

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

Methods

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

Precondition.error

Defined in

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


ok

โ–ธ ok(): PreconditionResult

Returns

PreconditionResult

Inherited from

Precondition.ok

Defined in

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


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/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

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

Precondition.reload

Defined in

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


run

โ–ธ run(message): PreconditionResult

Parameters

NameType
messageMessage<boolean>

Returns

PreconditionResult

Overrides

Precondition.run

Defined in

projects/framework/src/preconditions/GuildThreadOnly.ts:6


toJSON

โ–ธ toJSON(): PieceJSON

Defines the JSON.stringify behavior of this piece.

Returns

PieceJSON

Inherited from

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

Precondition.unload

Defined in

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