Class Bench

constructor

• new Bench(options?: BenchOptions): Bench

• Parameters

  • options: BenchOptions = {}

  Returns Bench

concurrency

Optional Readonlyname

Readonlyopts

Readonlyruntime

ReadonlyruntimeVersion

threshold

Number.POSITIVE_INFINITY
Copy

results

• get results(): (undefined | Readonly<TaskResult>)[]

• tasks results as an array

  Returns (undefined | Readonly<TaskResult>)[]

  the tasks results as an array

tasks

• get tasks(): Task[]

• tasks as an array

  Returns Task[]

  the tasks as an array

add

• add(name: string, fn: Fn, fnOpts?: FnOptions): this

• add a benchmark task to the task map

  Parameters

  • name: string

    the task name
  • fn: Fn

    the task function
  • fnOpts: FnOptions = {}

    the task function options

  Returns this

  the Bench instance

  Throws

  if the task already exists

addEventListener

• addEventListener<K extends BenchEvents>(
      type: K,
      listener: BenchEventsMap[K],
      options?: boolean | AddEventListenerOptions,
  ): void

• Adds a new handler for the type event. Any given listener is added only once per type and per capture option value.

  If the once option is true, the listener is removed after the next time a type event is dispatched.

  The capture option is not used by Node.js in any functional way other than tracking registered event listeners per the EventTarget specification. Specifically, the capture option is used as part of the key when registering a listener. Any individual listener may be added once with capture = false, and once with capture = true.

  Type Parameters

  • K extends BenchEvents

  Parameters

  • type: K
  • listener: BenchEventsMap[K]
  • Optionaloptions: boolean | AddEventListenerOptions

  Returns void

getTask

• getTask(name: string): undefined | Task

• get a task based on the task name

  Parameters

  • name: string

    the task name

  Returns undefined | Task

  the Task instance

remove

• remove(name: string): this

• remove a benchmark task from the task map

  Parameters

  • name: string

    the task name

  Returns this

  the Bench instance

removeEventListener

• removeEventListener<K extends BenchEvents>(
      type: K,
      listener: BenchEventsMap[K],
      options?: boolean | EventListenerOptions,
  ): void

• Removes the event listener in target's event listener list with the same type, callback, and options.

  Type Parameters

  • K extends BenchEvents

  Parameters

  • type: K
  • listener: BenchEventsMap[K]
  • Optionaloptions: boolean | EventListenerOptions

  Returns void

reset

• reset(): void

• reset tasks and remove their result

  Returns void

run

• run(): Promise<Task[]>

• run the added tasks that were registered using the add method

  Returns Promise<Task[]>

  the tasks array

runSync

• runSync(): Task[]

• Returns Task[]

table

• table(
      convert?: (task: Task) => Record<string, undefined | string | number>,
  ): (null | Record<string, undefined | string | number>)[]

• table of the tasks results

  Parameters

  • Optionalconvert: (task: Task) => Record<string, undefined | string | number>

    an optional callback to convert the task result to a table record

  Returns (null | Record<string, undefined | string | number>)[]

  the tasks results as an array of table records