Class ChainModifier

constructor

• new ChainModifier(
      options?: Partial<ChainModifierOptions>,
      ...chain?: DataModifier[],
  ): ChainModifier

  Constructs an instance of the modifier chain.

  Parameters

  • Optionaloptions: Partial<ChainModifierOptions>

    Options to configure the modifier chain.

  • Optional...chain: DataModifier[]

    Ordered chain of modifiers.

  Returns ChainModifier

Readonlychain

Readonlyoptions

Static ReadonlydefaultOptions

Statictypes

add

• add(modifier: DataModifier, eventDetail?: DataEventDetail): void

  Adds a configured modifier to the end of the modifier chain. Please note, that the modifier can be added multiple times.

  Parameters

  • modifier: DataModifier

    Configured modifier to add.

  • OptionaleventDetail: DataEventDetail

    Custom information for pending events.

  Returns void

benchmark

• benchmark(dataTable: DataTable, options?: BenchmarkOptions): number[]

  Runs a timed execution of the modifier on the given datatable. Can be configured to run multiple times.

  Parameters

  • dataTable: DataTable

    The datatable to execute

  • Optionaloptions: BenchmarkOptions

    Options. Currently supports iterations for number of iterations.

  Returns number[]

  An array of times in milliseconds

clear

• clear(eventDetail?: DataEventDetail): void

  Clears all modifiers from the chain.

  Parameters

  • OptionaleventDetail: DataEventDetail

    Custom information for pending events.

  Returns void

emit

• emit<E extends Event>(e: E): void

  Emits an event on the modifier to all registered callbacks of this event.

  Type Parameters

  • E extends Event

  Parameters

  • e: E

    Event object containing additonal event information.

  Returns void

modify

• modify(table: DataTable, eventDetail?: DataEventDetail): Promise<DataTable>

  Sequentially applies all modifiers in the chain to the given table, updating its modified property with the final result.

  Note: The modified property reference of the table gets replaced.

  Parameters

  • table: DataTable

    Table to modify.

  • OptionaleventDetail: DataEventDetail

    Custom information for pending events.

  Returns Promise<DataTable>

  Table with modified property as a reference.

modifyTable

• modifyTable(table: DataTable, eventDetail?: DataEventDetail): DataTable

  Applies several modifications to the table.

  Note: The modified property reference of the table gets replaced.

  Parameters

  • table: DataTable

    Table to modify.

  • OptionaleventDetail: DataEventDetail

    Custom information for pending events.

  Returns DataTable

  Table as a reference.

  Emits

  ChainDataModifier#execute

  Emits

  ChainDataModifier#afterExecute

on

• on<
      T extends
          | "afterBenchmark"
          | "afterBenchmarkIteration"
          | "error"
          | "modify"
          | "afterModify"
          | "clearChain"
          | "afterClearChain"
          | "addModifier"
          | "afterAddModifier"
          | "removeModifier"
          | "afterRemoveModifier",
  >(
      type: T,
      callback: DataEventCallback<
          ChainModifier,
          | Extract<BenchmarkEvent, { type: T }>
          | Extract<ErrorEvent, { type: T }>
          | Extract<ModifyEvent, { type: T }>,
      >,
  ): Function

  Registers a callback for a specific modifier event.

  Type Parameters

  • T extends
        | "afterBenchmark"
        | "afterBenchmarkIteration"
        | "error"
        | "modify"
        | "afterModify"
        | "clearChain"
        | "afterClearChain"
        | "addModifier"
        | "afterAddModifier"
        | "removeModifier"
        | "afterRemoveModifier"

  Parameters

  • type: T

    Event type as a string.

  • callback: DataEventCallback<
        ChainModifier,
        | Extract<BenchmarkEvent, { type: T }>
        | Extract<ErrorEvent, { type: T }>
        | Extract<ModifyEvent, { type: T }>,
    >

    Function to register for an modifier callback.

  Returns Function

  Function to unregister callback from the modifier event.

remove

• remove(modifier: DataModifier, eventDetail?: DataEventDetail): void

  Removes a configured modifier from all positions in the modifier chain.

  Parameters

  • modifier: DataModifier

    Configured modifier to remove.

  • OptionaleventDetail: DataEventDetail

    Custom information for pending events.

  Returns void