Class RangeModifier

constructor

• new RangeModifier(options?: Partial<RangeModifierOptions>): RangeModifier

  Constructs an instance of the range modifier.

  Parameters

  • Optionaloptions: Partial<RangeModifierOptions>

    Options to configure the range modifier.

  Returns RangeModifier

Readonlyoptions

Static ReadonlydefaultOptions

Statictypes

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

emit

• emit<E extends DataModifierEvent>(e?: E): void

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

  Type Parameters

  • E extends DataModifierEvent

  Parameters

  • Optionale: E

    Event object containing additonal event information.

  Returns void

modify

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

  Modifies the given table and sets its modified property as a reference to the modified table. If modified property does not exist on the original table, it's always created.

  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

  Replaces table rows with ranged rows. If the given table does not have defined a modified property, the filtering is applied in-place on the original table rather than on a modified copy.

  Parameters

  • table: DataTable

    Table to modify.

  • OptionaleventDetail: DataEventDetail

    Custom information for pending events.

  Returns DataTable

  Table with modified property as a reference or modified table, if modified property of the original table is undefined.

on

• on<
      T extends
          | "afterBenchmark"
          | "afterBenchmarkIteration"
          | "error"
          | "modify"
          | "afterModify",
  >(
      type: T,
      callback: DataEventCallback<
          RangeModifier,
          | 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"

  Parameters

  • type: T

    Event type as a string.

  • callback: DataEventCallback<
        RangeModifier,
        | 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.