Skip to content

Interface: PluginWithExtension<E>

Plugin return type with extension, which includes the plugin ID, name, dependencies, and extension.

This type is used to define a plugin at plugin function.

Extends

Signature

ts
export interface PluginWithExtension<
  E extends GunshiParams['extensions'] = DefaultGunshiParams['extensions']
> extends Plugin<E>

Type Parameters

NameDescription
E extends GunshiParams['extensions'] = DefaultGunshiParams['extensions']A type extending GunshiParams to specify the shape of CommandContext's extensions.

Properties

NameTypeDescription
dependencies (optional)(PluginDependency | string)[]Plugin dependencies
extensionCommandContextExtension<E>Plugin extension
idstringPlugin identifier
namestringPlugin name

Released under the MIT License.