Interface PluginFactory<Options>

A standard way to define a plugin and which options it needs to work

See

interface PluginFactory<Options extends BaseOptions> {
configSchema: null | Readonly<Record<string, BaseConfigSchema>>;
make(options: Options): Promise<PluginInstance>;
}

Type Parameters

Options extends BaseOptions
The options that we'll pass to create the plugin.

Index

Properties

Methods

Properties

`Readonly`configSchema

configSchema: null | Readonly<Record<string, BaseConfigSchema>>

The schema of how the Options will be created from the user's configuration

It's an object with string keys, and each value is an object of BaseConfigSchema type.

Methods

make

make(options: Options): Promise<PluginInstance>
Parameters
- options: Options
Returns Promise<PluginInstance>
- Defined in types.ts:38