Class Bench

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

Hierarchy

EventTarget
- Bench

Implements

BenchLike

Index

Constructors

constructor

new Bench(options?: BenchOptions): Bench
Parameters
- options: BenchOptions = {}
Returns Bench
Overrides EventTarget.constructor
- Defined in src/bench.ts:164

Properties

addEventListener

addEventListener: <K extends BenchEvents>(
    type: K,
    listener: EventListener<K> | EventListenerObject<K, "bench"> | null,
    options?: boolean | AddEventListenerOptions,
) => void

The addEventListener() method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.

MDN Reference

`Readonly`concurrency

concurrency: "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.

`Readonly`iterations

iterations: number

The amount of executions per task.

`Readonly`name

name: string | undefined

The benchmark name.

`Readonly`now

now: () => number

A function to get a timestamp.

removeEventListener

removeEventListener: <K extends BenchEvents>(
    type: K,
    listener: EventListener<K> | EventListenerObject<K, "bench"> | null,
    options?: boolean | EventListenerOptions,
) => void

Removes a previously registered event listener.

`Readonly`retainSamples

retainSamples: boolean

Should samples be retained for further custom processing

`Readonly`runtime

runtime: JSRuntime

The JavaScript runtime environment.

`Readonly`runtimeVersion

runtimeVersion: string

The JavaScript runtime version.

`Readonly`setup

setup: (task: Task, mode: "warmup" | "run") => void | Promise<void>

A setup function that runs before each task execution.

`Optional` `Readonly`signal

signal?: AbortSignal

An AbortSignal to cancel the benchmark.

`Readonly`teardown

teardown: (task: Task, mode: "warmup" | "run") => void | Promise<void>

A teardown function that runs after each task execution.

`Readonly`threshold

threshold: number

The maximum number of concurrent tasks to run

Default

Number.POSITIVE_INFINITY

`Readonly`throws

throws: boolean

Whether to throw an error if a task function throws

Default

false

`Readonly`time

time: number

The amount of time to run each task.

`Readonly`timestampProvider

timestampProvider: TimestampProvider

A timestamp provider and its related functions.

`Readonly`warmup

warmup: boolean

Whether to warmup the tasks before running them

`Readonly`warmupIterations

warmupIterations: number

The amount of warmup iterations per task.

`Readonly`warmupTime

warmupTime: number

The amount of time to warmup each task.

Accessors

results

get results(): Readonly<TaskResult>[]
The tasks results as an array.

Returns Readonly<TaskResult>[]
the tasks results
- Defined in src/bench.ts:147

tasks

get tasks(): Task[]
The tasks as an array.

Returns Task[]
An array containing all benchmark tasks
- Defined in src/bench.ts:155

Methods

add

add(name: string, fn: Fn, fnOpts?: FnOptions): this
Adds 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
when a task with the same name already exists
- Defined in src/bench.ts:218

dispatchEvent

dispatchEvent(event: Event): boolean
The dispatchEvent() method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order. The normal event processing rules (including the capturing and optional bubbling phase) also apply to events dispatched manually with dispatchEvent().

MDN Reference
Parameters
- event: Event
Returns boolean
Implementation of BenchLike.dispatchEvent
Inherited from EventTarget.dispatchEvent
- Defined in node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.dom.d.ts:14386

getTask

getTask(name: string): Task | undefined
Gets a task based on the task name.
Parameters
- name: string
  the task name
Returns Task | undefined
the Task instance or undefined if not found
- Defined in src/bench.ts:234

remove

remove(name: string): this
Removes a benchmark task from the task map.
Parameters
- name: string
  the task name
Returns this
the Bench instance
- Defined in src/bench.ts:243

reset

reset(): void
Resets all tasks and removes their results.

Returns void
- Defined in src/bench.ts:255

run

run(): Promise<Task[]>
Runs the added benchmark tasks.

Returns Promise<Task[]>
the tasks array
- Defined in src/bench.ts:266

runSync

runSync(): Task[]
Runs the added benchmark tasks synchronously.

Returns Task[]
the tasks array
- Defined in src/bench.ts:295

table

table(
convert?: ConsoleTableConverter,
): (Record<string, string | number | undefined> | null)[]
Returns the tasks results as a table.
Parameters
- convert: ConsoleTableConverter = defaultConvertTaskResultForConsoleTable
  an optional callback to convert the task result to a table record
Returns (Record<string, string | number | undefined> | null)[]
the tasks results as an array of table records
- Defined in src/bench.ts:317

Class Bench

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns Bench

Properties

addEventListener

Readonlyconcurrency

Readonlyiterations

Readonlyname

Readonlynow

removeEventListener

ReadonlyretainSamples

Readonlyruntime

ReadonlyruntimeVersion

Readonlysetup

Optional Readonlysignal

Readonlyteardown

Readonlythreshold

Default

Readonlythrows

Default

Readonlytime

ReadonlytimestampProvider

Readonlywarmup

ReadonlywarmupIterations

ReadonlywarmupTime

Accessors

results

Returns Readonly<TaskResult>[]

tasks

Returns Task[]

Methods

add

Parameters

Returns this

Throws

dispatchEvent

Parameters

Returns boolean

getTask

Parameters

Returns Task | undefined

remove

Parameters

Returns this

reset

Returns void

run

Returns Promise<Task[]>

runSync

Returns Task[]

table

Parameters

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

Settings

On This Page

`Readonly`concurrency

`Readonly`iterations

`Readonly`name

`Readonly`now

`Readonly`retainSamples

`Readonly`runtime

`Readonly`runtimeVersion

`Readonly`setup

`Optional` `Readonly`signal

`Readonly`teardown

`Readonly`threshold

`Readonly`throws

`Readonly`time

`Readonly`timestampProvider

`Readonly`warmup

`Readonly`warmupIterations

`Readonly`warmupTime