Skip to content

gunshi / default / Plugin

Type Alias: Plugin<E>

ts
type Plugin<E> = PluginFunction & object;

Gunshi plugin, which is a function that receives a PluginContext.

Type declaration

dependencies?

ts
optional dependencies: (PluginDependency | string)[];

extension?

ts
optional extension: CommandContextExtension<E>;

id

ts
id: string;

name?

ts
optional name: string;

Type Parameters

Type ParameterDefault type
E extends GunshiParams["extensions"]DefaultGunshiParams["extensions"]

Param

A PluginContext.

Returns

An Awaitable that resolves when the plugin is loaded.

Since

v0.27.0

Released under the MIT License.