PluginBuilder<Options>
Defined in: packages/client/src/plugins/plugin-builder.ts:22
What every builder (CommandBuilder, EventBuilder, …) produces: a build() method tagged with its kind.
Type Parameters
Options
Options = void
Implements
Brick<PluginDefinition<Options>>
Constructors
Constructor
new PluginBuilder<Options>(): PluginBuilder<Options>;Returns
PluginBuilder<Options>
Properties
[BRICK]
readonly [BRICK]: "plugin";Defined in: packages/client/src/plugins/plugin-builder.ts:23
Implementation of
Methods
addBricks()
addBricks(...bricks): this;Defined in: packages/client/src/plugins/plugin-builder.ts:50
Parameters
bricks
...Brick<unknown>[]
Static list of bricks
Returns
this
build()
build(): PluginDefinition<Options>;Defined in: packages/client/src/plugins/plugin-builder.ts:68
Returns
PluginDefinition<Options>
Implementation of
configure()
configure(this, options): PluginBuilder<Options>;Defined in: packages/client/src/plugins/plugin-builder.ts:56
Parameters
this
Options extends void ? never : PluginBuilder<Options>
options
Options
Options given to the factory
Returns
PluginBuilder<Options>
setBricks()
setBricks(factory): this;Defined in: packages/client/src/plugins/plugin-builder.ts:44
Parameters
factory
PluginBricksFactory<Options>
Receives the client and the options, returns the bricks
Returns
this
setDescription()
setDescription(description): this;Defined in: packages/client/src/plugins/plugin-builder.ts:38
Parameters
description
string
Free text for the bot author
Returns
this
setName()
setName(name): this;Defined in: packages/client/src/plugins/plugin-builder.ts:32
Parameters
name
string
Lowercase, letters digits _ and -, 1 to 32 characters
Returns
this