gunshi / default / PluginOptions

Interface: PluginOptions<DepExt, Id, Deps, Ext, ResolvedDepExt, PluginExt, MergedExt>

Plugin definition options

Since

v0.27.0

Type Parameters

Type Parameter	Default type
DepExt extends ExtendContext	DefaultGunshiParams["extensions"]
Id extends string	string
Deps extends ReadonlyArray<PluginDependency | string>	(PluginDependency | string)[]
Ext extends Record<string, unknown>	object
ResolvedDepExt extends GunshiParams	GunshiParams<{ args: Args; extensions: InferDependencyExtensions<Deps, DepExt>; }>
PluginExt extends PluginExtension<Ext, ResolvedDepExt>	PluginExtension<Ext, ResolvedDepExt>
MergedExt extends GunshiParams	GunshiParams<{ args: Args; extensions: MergeExtension<Id, InferDependencyExtensions<Deps, DepExt>, Awaited<ReturnType<PluginExt>>>; }>

Properties

Property	Type	Description
dependencies?	Deps	Plugin dependencies
extension?	PluginExt	Plugin extension
id	Id	Plugin unique identifier
name?	string	Plugin name
onExtension?	OnPluginExtension<MergedExt>	Callback for when the plugin is extended with extension option.
setup?	PluginFunction<MergedExt>	Plugin setup function