Class Bench

The Bench class keeps track of the benchmark tasks and controls them.

Hierarchy

  • EventTarget
    • Bench

Constructors

constructor

Properties

concurrency iterations name? now runtime runtimeVersion setup signal? teardown threshold throws time warmup warmupIterations warmupTime

Accessors

results tasks

Methods

add addEventListener dispatchEvent getTask remove removeEventListener reset run table

Constructors

constructor

Properties

concurrency

concurrency: null | "task" | "bench" = null

Executes tasks concurrently based on the specified concurrency mode.

  • When mode is set to null (default), concurrency is disabled.
  • When mode is set to 'task', each task's iterations (calls of a task function) run concurrently.
  • When mode is set to 'bench', different tasks within the bench run concurrently. Concurrent cycles.

iterations

iterations: number = defaultMinimumIterations

Optional Readonlyname

name?: string

The benchmark name.

Readonlynow

now: (() => number) = now

Type declaration

    • (): number

    • Returns the current high resolution millisecond timestamp, where 0 represents the start of the current node process.

      Returns number

      Since

      v8.5.0

Readonlyruntime

runtime: JSRuntime | "unknown"

The JavaScript runtime environment.

ReadonlyruntimeVersion

runtimeVersion: string

The JavaScript runtime version.

Readonlysetup

setup: Hook

Optional Readonlysignal

signal?: AbortSignal

Readonlyteardown

teardown: Hook

threshold

threshold: number = Number.POSITIVE_INFINITY

The maximum number of concurrent tasks to run

Default

Number.POSITIVE_INFINITY

throws

throws: boolean = false

time

time: number = defaultMinimumTime

warmup

warmup: boolean = true

warmupIterations

warmupIterations: number = defaultMinimumWarmupIterations

warmupTime

warmupTime: number = defaultMinimumWarmupTime

Accessors

results

tasks

Methods

add

  • add(name, fn, opts?): this

  • add a benchmark task to the task map

    Parameters

    • name: string

      the task name

    • fn: Fn

      the task function

    • opts: FnOptions = {}

      the task options

    Returns this

    the Bench instance

addEventListener

  • addEventListener<K>(type, listener, options?): 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

    Parameters

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

    Returns void

dispatchEvent

  • dispatchEvent(event): boolean

  • Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

    Parameters

    • event: Event

    Returns boolean

getTask

  • getTask(name): undefined | Task

  • get a task based on the task name

    Parameters

    • name: string

      the task name

    Returns undefined | Task

    the task

remove

  • remove(name): this

  • remove a benchmark task from the task map

    Parameters

    • name: string

      the task name

    Returns this

    the Bench instance

removeEventListener

  • removeEventListener<K>(type, listener, options?): void

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

    Type Parameters

    Parameters

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

    Returns void

reset

  • reset(): void

  • reset each task and remove its result

    Returns void

run

  • run(): Promise<Task[]>

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

    Returns Promise<Task[]>

    the tasks array

table

  • table(convert?): (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

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

        • Parameters

          Returns Record<string, undefined | string | number>

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

    the tasks results as an array of table records

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods