@bluelibs/runner - v6.3.1
    Preparing search index...

    Interface IHookDefinition<TDependencies, TOn, TMeta>

    interface IHookDefinition<
        TDependencies extends DependencyMapType = {},
        TOn extends OnType = any,
        TMeta extends ITaskMeta = any,
    > {
        dependencies?: TDependencies | (() => TDependencies);
        id: string;
        meta?: TMeta;
        on: TOn;
        order?: number;
        run: (
            event: IEventEmission<
                HasSelectorEntry<TOn> extends true
                    ? any
                    : TOn extends "*"
                        ? any
                        : TOn extends readonly IEventDefinition<any>[]
                            ? CommonPayload<TOn>
                            : ExtractEventPayload<TOn>,
            >,
            dependencies: DependencyValuesType<TDependencies>,
        ) => Promise<HookRunResult<TOn>>;
        tags?: HookTagType[];
        throws?: ThrowsList;
    }

    Type Parameters

    Index

    Properties

    dependencies? id meta? on order? run tags? throws?

    Properties

    dependencies?: TDependencies | (() => TDependencies)
    id: string
    meta?: TMeta
    on: TOn

    Event subscription target for the hook.

    Use exact event refs or onAnyOf(...) to preserve payload autocomplete. Selector-based targets such as subtreeOf(...) and predicates trade autocomplete for broader bootstrap-time matching.

    order?: number

    Listener execution order. Lower numbers run first.

    run: (
        event: IEventEmission<
            HasSelectorEntry<TOn> extends true
                ? any
                : TOn extends "*"
                    ? any
                    : TOn extends readonly IEventDefinition<any>[]
                        ? CommonPayload<TOn>
                        : ExtractEventPayload<TOn>,
        >,
        dependencies: DependencyValuesType<TDependencies>,
    ) => Promise<HookRunResult<TOn>>
    tags?: HookTagType[]
    throws?: ThrowsList

    Declares which typed errors are part of this hook's contract. Declarative only — does not imply DI or enforcement.

    Settings

    Member Visibility

    On This Page

    Properties