Interface FrameworkPlugin<ComponentType>

Framework prover plugin.

interface FrameworkPlugin<ComponentType> {
    manifest: PackageJSON;
    name: string;
    config<Type extends keyof Map>(
        key: string,
        type: Type,
        options?: Map[Type],
    ): PluginBinding<Type>;
    onExit(): Awaitable<void>;
    onLoad(): Awaitable<void>;
    wrap(component: ComponentType): Snippet<[any]>;
}

Type Parameters

ComponentType

Hierarchy (View Summary)

FrameworkPluginPrototype
Omit<Plugin, "constructor">
- FrameworkPlugin

Index

Properties

Methods

config onExit onLoad wrap

Properties

`Readonly`manifest

manifest: PackageJSON

`Readonly`name

name: string

Methods

config

config<Type extends keyof Map>(
    key: string,
    type: Type,
    options?: Map[Type],
): PluginBinding<Type>
create config binding
Type Parameters
- Type extends keyof Map
Parameters
- key: string
  config key
- type: Type
  config type
- Optionaloptions: Map[Type]
  binding options
Returns PluginBinding<Type>
binding instance
Inherited from PluginPrototype.config
- Defined in packages/types/src/duplicis.d.ts:268

onExit

onExit(): Awaitable<void>
Returns Awaitable<void>
Overrides Plugin.onExit
- Defined in packages/types/src/duplicis.d.ts:319

onLoad

onLoad(): Awaitable<void>
Returns Awaitable<void>
Overrides Plugin.onLoad
- Defined in packages/types/src/duplicis.d.ts:318

wrap

wrap(component: ComponentType): Snippet<[any]>
Parameters
- component: ComponentType
Returns Snippet<[any]>
- Defined in packages/types/src/duplicis.d.ts:317