Class SyncWaterfallHook<T, AdditionalOptions>

constructor

• new SyncWaterfallHook<T, AdditionalOptions>(args?, name?): SyncWaterfallHook<T, AdditionalOptions>

• Type Parameters

  • T

  • AdditionalOptions = UnsetAdditionalOptions

  Parameters

  • Optional args: FixedSizeArray<AsArray<T>["length"], string>

  • Optional name: string

  Returns SyncWaterfallHook<T, AdditionalOptions>

name

taps

call

• call(...args): AsArray<T>[0]

• Parameters

  • Rest ...args: AsArray<T>

  Returns AsArray<T>[0]

callAsync

• callAsync(...args): void

• Parameters

  • Rest ...args: Append<AsArray<T>, Callback<Error, AsArray<T>[0]>>

  Returns void

intercept

• intercept(interceptor): void

• Parameters

  • interceptor: HookInterceptor<T, AsArray<T>[0], AdditionalOptions>

  Returns void

isUsed

• isUsed(): boolean

• Returns boolean

promise

• promise(...args): Promise<AsArray<T>[0]>

• Parameters

  • Rest ...args: AsArray<T>

  Returns Promise<AsArray<T>[0]>

tap

• tap(options, fn): void

• Parameters

  • options: string | TapOptions & {
        name: string;
    } & IfSet<AdditionalOptions>

  • fn: ((...args) => AsArray<T>[0])

    • • (...args): AsArray<T>[0]

      • Parameters

        • Rest ...args: AsArray<T>

        Returns AsArray<T>[0]

  Returns void

withOptions

• withOptions(options): Omit<SyncWaterfallHook<T, AdditionalOptions>, "promise" | "call" | "callAsync">

• Parameters

  • options: TapOptions & IfSet<AdditionalOptions>

  Returns Omit<SyncWaterfallHook<T, AdditionalOptions>, "promise" | "call" | "callAsync">