Interface IPlugin

[[include:Plugins.md]]

interface IPlugin {
    id: string;
    getPlugin(container: Container): Promise<IContainerPlugin>;
    loadOptions(options: Options, source?: RecursivePartial<IOptions>): void;
    needsPlugin(options?: RecursivePartial<IOptions>): boolean;
}

Index

Properties

Methods

getPlugin loadOptions needsPlugin

Properties

`Readonly`id

id: string

Methods

getPlugin

getPlugin(container): Promise<IContainerPlugin>
Parameters
- container: Container
Returns Promise<IContainerPlugin>
- Defined in Core/Interfaces/IPlugin.ts:12

loadOptions

loadOptions(options, source?): void
Parameters
- options: Options
- Optionalsource: RecursivePartial<IOptions>
Returns void
- Defined in Core/Interfaces/IPlugin.ts:14

needsPlugin

needsPlugin(options?): boolean
Parameters
- Optionaloptions: RecursivePartial<IOptions>
Returns boolean
- Defined in Core/Interfaces/IPlugin.ts:16