Interface IHook<TDependencies, TOn, TMeta>

interface IHook<TDependencies, TOn, TMeta> {
    [symbolFilePath]: string;
    [symbolHook]: true;
    dependencies: TDependencies | (() => TDependencies);
    id: string;
    meta?: TMeta;
    on: TOn;
    order?: number;
    run: ((event: IEventEmission<TOn extends "*"
        ? any
        : ExtractEventParams<TOn>>, dependencies: DependencyValuesType<TDependencies>) => Promise<any>);
    tags: TagType[];
}

Type Parameters

TDependencies extends DependencyMapType = {}
TOn extends "*" | IEventDefinition<any> = any
TMeta extends ITaskMeta = any

Hierarchy (view full)

IHookDefinition<TDependencies, TOn, TMeta>
- IHook

Index

Properties

[symbolFilePath] [symbolHook] dependencies id meta? on order? run tags

Properties

[symbolFilePath]

[symbolFilePath]: string

[symbolHook]

[symbolHook]: true

dependencies

dependencies: TDependencies | (() => TDependencies)

id

id: string

`Optional`meta

meta?: TMeta

on

on: TOn

`Optional`order

order?: number

Listener execution order. Lower numbers run first.

run

run: ((event: IEventEmission<TOn extends "*"
? any
: ExtractEventParams<TOn>>, dependencies: DependencyValuesType<TDependencies>) => Promise<any>)

tags

tags: TagType[]