Interface HonuaPluginInstance<K, E>`Experimental`

Hooks are optional after initialize so inert plugins carry no lifecycle work.

interface HonuaPluginInstance<
    K extends HonuaPluginKind = HonuaPluginKind,
    E extends HonuaPluginExtensionKindMap[K] = HonuaPluginExtensionKindMap[K],
> {
    dispose?: (
        context: HonuaPluginLifecycleContext<K>,
    ) => void | Promise<void>;
    extension: E;
    start?: (context: HonuaPluginLifecycleContext<K>) => void | Promise<void>;
    stop?: (context: HonuaPluginLifecycleContext<K>) => void | Promise<void>;
}

Type Parameters

K extends HonuaPluginKind = HonuaPluginKind
E extends HonuaPluginExtensionKindMap[K] = HonuaPluginExtensionKindMap[K]

Index

Properties

dispose? extension start? stop?

Properties

`Optional` `Readonly` `Experimental`dispose

dispose?: (context: HonuaPluginLifecycleContext<K>) => void | Promise<void>

`Readonly` `Experimental`extension

extension: E

`Optional` `Readonly` `Experimental`start

start?: (context: HonuaPluginLifecycleContext<K>) => void | Promise<void>

`Optional` `Readonly` `Experimental`stop

stop?: (context: HonuaPluginLifecycleContext<K>) => void | Promise<void>