gunshi / default / PluginWithExtension

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

• Plugin<E>

Type Parameters

Type Parameter	Default type
E extends GunshiParams["extensions"]	DefaultGunshiParams["extensions"]

PluginWithExtension(ctx): Awaitable<void>;

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.

Parameters

Parameter	Type
ctx	Readonly<PluginContext<G>>

Returns

Awaitable<void>

Properties

Property	Type	Description	Overrides
dependencies?	(string | PluginDependency)[]	Plugin dependencies	Plugin.dependencies
extension	CommandContextExtension<E>	Plugin extension	Plugin.extension
id	string	Plugin identifier	Plugin.id
name	string	Plugin name	Plugin.name