Class PluginPackage<TConfig, TEnv>

A wrap package, capable of producing instances of a wrapper and its manifest

Type Parameters

TConfig
TEnv extends Record<string, unknown> = Record<string, unknown>

Hierarchy

PluginPackage

Implements

IWrapPackage

Index

Constructors

Properties

_manifest _pluginModule

Methods

createWrapper getManifest from

Constructors

constructor

new PluginPackage<TConfig, TEnv>(_pluginModule, _manifest): PluginPackage<TConfig, TEnv>
Type Parameters
- TConfig
- TEnv extends Record<string, unknown> = Record<string, unknown>
Parameters
- _pluginModule: PluginModule<TConfig, TEnv>
- _manifest: WrapManifest
Returns PluginPackage<TConfig, TEnv>
- Defined in PluginPackage.ts:13

Properties

`Private` _manifest

_manifest: WrapManifest

`Private` _pluginModule

_pluginModule: PluginModule<TConfig, TEnv>

Methods

createWrapper

createWrapper(): Promise<Result<Wrapper, Error>>
Produce an instance of the wrapper

Returns Promise<Result<Wrapper, Error>>
A Promise with a Result containing the wrapper or an error
Implementation of IWrapPackage.createWrapper
- Defined in PluginPackage.ts:57

getManifest

getManifest(): Promise<Result<WrapManifest, Error>>
Produce an instance of the wrap manifest

Returns Promise<Result<WrapManifest, Error>>
A Promise with a Result containing the wrap manifest or an error
Implementation of IWrapPackage.getManifest
- Defined in PluginPackage.ts:53

`Static` from

from<TConfig, TEnv>(pluginModule, manifest?): PluginPackage<TConfig, TEnv>
Type Parameters
- TConfig
- TEnv extends Record<string, unknown> = Record<string, unknown>
Parameters
- pluginModule: PluginModule<TConfig, TEnv>
- Optional manifest: WrapManifest
Returns PluginPackage<TConfig, TEnv>
- Defined in PluginPackage.ts:18
from<TEnv>(getPluginFuncs, manifest?): PluginPackage<never, TEnv>
Type Parameters
- TEnv extends Record<string, unknown> = Record<string, unknown>
Parameters
- getPluginFuncs: GetPluginMethodsFunc<TEnv>
- Optional manifest: WrapManifest
Returns PluginPackage<never, TEnv>
- Defined in PluginPackage.ts:25

Generated using TypeDoc