Interface HookFluentBuilder<TDeps, TOn, TMeta>

id

build

• build(): IHook<TDeps, ResolvedOn<TOn>, TMeta>

  Build the hook definition. Requires .on() and .run() to be called first.

  Returns IHook<TDeps, ResolvedOn<TOn>, TMeta>

  Throws

  if on or run are not set

dependencies

• dependencies<TNewDeps extends DependencyMapType>(
      deps: TNewDeps | (() => TNewDeps),
      options?: { override?: false },
  ): HookFluentBuilder<TDeps & TNewDeps, TOn, TMeta>

  Type Parameters

  • TNewDeps extends DependencyMapType

  Parameters

  • deps: TNewDeps | (() => TNewDeps)
  • Optionaloptions: { override?: false }

  Returns HookFluentBuilder<TDeps & TNewDeps, TOn, TMeta>

• dependencies<TNewDeps extends DependencyMapType>(
      deps: TNewDeps | (() => TNewDeps),
      options: { override: true },
  ): HookFluentBuilder<TNewDeps, TOn, TMeta>

  Type Parameters

  • TNewDeps extends DependencyMapType

  Parameters

  • deps: TNewDeps | (() => TNewDeps)
  • options: { override: true }

  Returns HookFluentBuilder<TNewDeps, TOn, TMeta>

meta

• meta<TNewMeta extends ITaskMeta>(
      m: TNewMeta,
  ): HookFluentBuilder<TDeps, TOn, TNewMeta>

  Type Parameters

  • TNewMeta extends ITaskMeta

  Parameters

  • m: TNewMeta

  Returns HookFluentBuilder<TDeps, TOn, TNewMeta>

on

• on<TNewOn extends ValidOnTarget>(
      on: TNewOn,
  ): HookFluentBuilder<TDeps, TNewOn, TMeta>

  Type Parameters

  • TNewOn extends ValidOnTarget

  Parameters

  • on: TNewOn

  Returns HookFluentBuilder<TDeps, TNewOn, TMeta>

order

• order(order: number): HookFluentBuilder<TDeps, TOn, TMeta>

  Parameters

  • order: number

  Returns HookFluentBuilder<TDeps, TOn, TMeta>

run

• run(
      fn: (
          event: IEventEmission<
              ResolvedOn<TOn> extends "*"
                  ? any
                  : ResolvedOn<TOn> extends readonly IEventDefinition<any>[]
                      ? CommonPayload<readonly IEventDefinition<any>[] & ResolvedOn<TOn>>
                      : ExtractEventPayload<ResolvedOn<TOn>>,
          >,
          dependencies: DependencyValuesType<TDependencies>,
      ) => Promise<any>,
  ): HookFluentBuilder<TDeps, TOn, TMeta>

  Set the hook's run handler. Required before build().

  Parameters

  • fn: (
        event: IEventEmission<
            ResolvedOn<TOn> extends "*"
                ? any
                : ResolvedOn<TOn> extends readonly IEventDefinition<any>[]
                    ? CommonPayload<readonly IEventDefinition<any>[] & ResolvedOn<TOn>>
                    : ExtractEventPayload<ResolvedOn<TOn>>,
        >,
        dependencies: DependencyValuesType<TDependencies>,
    ) => Promise<any>

  Returns HookFluentBuilder<TDeps, TOn, TMeta>

tags

• tags<TNewTags extends TagType[]>(
      t: TNewTags,
      options?: { override?: boolean },
  ): HookFluentBuilder<TDeps, TOn, TMeta>

  Type Parameters

  • TNewTags extends TagType[]

  Parameters

  • t: TNewTags
  • Optionaloptions: { override?: boolean }

  Returns HookFluentBuilder<TDeps, TOn, TMeta>

throws

• throws(list: ThrowsList): HookFluentBuilder<TDeps, TOn, TMeta>

  Declare which typed errors this hook may throw (declarative only).

  Parameters

  • list: ThrowsList

  Returns HookFluentBuilder<TDeps, TOn, TMeta>