gunshi / default / plugin

Function: plugin()

Call Signature

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

Create a plugin with extension capabilities

Type Parameters

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

Parameters

Parameter	Type	Description
options	{ extension: F; name: N; setup?: (ctx) => Awaitable<void>; }	plugin options
options.extension	F	-
options.name	N	-
options.setup?	(ctx) => Awaitable<void>	-

Returns

PluginWithExtension<ReturnType<F>>

Call Signature

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

Create a plugin with extension capabilities

Parameters

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

Returns

PluginWithoutExtension<{ }>