Interface OnEventCallChain

Hierarchy

  • CallChain
    • OnEventCallChain

Methods

call onEvent pass skip

Methods

call

  • Calls a pass in this chain with the given arguments.

    When this is called for the last pass, the final result would be an args tuple.

    Type Parameters

    • TArgs extends any[]

      Pass arguments tuple type.

    Parameters

    • pass: ((this, ...args) => any)

      A pass to call.

        • (this, ...args): any

        • Parameters

          • this: void
          • Rest ...args: TArgs

          Returns any

    • args: TArgs

      An array of arguments for the call.

    Returns void

onEvent

  • Calls a pass in this chain with each event received from the given sender.

    Type Parameters

    • TEvent extends any[]

      An event type. This is a tuple of argument types of the next pass.

    Parameters

    • pass: ((this, ...event) => any)

      A pass to call.

        • (this, ...event): any

        • Parameters

          • this: void
          • Rest ...event: TEvent

          Returns any

    • sender: EventSender<TEvent>

      A sender of events to pass down the chain.

    Returns void

pass

  • Calls a pass in this chain with the given argument.

    When this is called for the last pass, the final result would be arg.

    Type Parameters

    • TArg

    Parameters

    • pass: ((this, arg) => any)

      A pass to call.

        • (this, arg): any

        • Parameters

          • this: void
          • arg: TArg

          Returns any

    • arg: TArg

      Single argument for the call.

    Returns void

skip

  • Skips the rest of the passes.

    Parameters

    • Optional result: unknown

      Call chain result.

    Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc