gunshi / default / Plugin

Type Alias: Plugin<E>

type Plugin<E> = PluginFunction & object;

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

Type Declaration

dependencies?

optional dependencies: (PluginDependency | string)[];

extension?

optional extension: CommandContextExtension<E>;

id

id: string;

name?

optional name: string;

Type Parameters

Type Parameter	Default type	Description
E extends GunshiParams["extensions"]	DefaultGunshiParams["extensions"]	A type extending GunshiParams to specify the shape of CommandContext's extensions.

Param

A PluginContext.

Returns

An Awaitable that resolves when the plugin is loaded.

Since

v0.27.0