gunshi / default / plugin

Function: plugin()

Call Signature

function plugin<N, P>(options): PluginWithExtension<ReturnType<P>>;

Create a plugin with extension capabilities

Type Parameters

Type Parameter
N extends string
P extends PluginExtension<any, DefaultGunshiParams>

Parameters

Parameter	Type	Description
options	{ dependencies?: (string | PluginDependency)[]; extension: P; name: N; onExtension?: OnPluginExtension<{ args: Args; extensions: { [K in string]: ReturnType<P> }; }>; setup?: (ctx) => Awaitable<void>; }	plugin options
options.dependencies?	(string | PluginDependency)[]	-
options.extension	P	-
options.name	N	-
options.onExtension?	OnPluginExtension<{ args: Args; extensions: { [K in string]: ReturnType<P> }; }>	-
options.setup?	(ctx) => Awaitable<void>	-

Returns

PluginWithExtension<ReturnType<P>>

Call Signature

function plugin(options): PluginWithoutExtension<{
}>;

Create a plugin with extension capabilities

Parameters

Parameter	Type	Description
options	{ dependencies?: (string | PluginDependency)[]; name: string; setup?: (ctx) => Awaitable<void>; }	plugin options
options.dependencies?	(string | PluginDependency)[]	-
options.name	string	-
options.setup?	(ctx) => Awaitable<void>	-

Returns

PluginWithoutExtension<{ }>