Class Bench

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

Hierarchy

EventTarget
- Bench

Index

Constructors

constructor

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

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.

`Optional` `Readonly`name

name?: string

The benchmark name.

`Readonly`opts

opts: Readonly<BenchOptions>

The options.

`Readonly`runtime

runtime: JSRuntime | "unknown"

The JavaScript runtime environment.

`Readonly`runtimeVersion

runtimeVersion: string

The JavaScript runtime version.

threshold

threshold: number = Number.POSITIVE_INFINITY

The maximum number of concurrent tasks to run

Default

Number.POSITIVE_INFINITY

Accessors

results

get results(): (undefined | Readonly<TaskResult>)[]
tasks results as an array

Returns (undefined | Readonly<TaskResult>)[]
the tasks results as an array
- Defined in src/bench.ts:75

tasks

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

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

Methods

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
- Defined in src/bench.ts:132

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
Overrides EventTarget.addEventListener
- Defined in src/bench.ts:143

dispatchEvent

dispatchEvent(event: 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
Inherited from EventTarget.dispatchEvent
- Defined in node_modules/.pnpm/@types+node@22.13.10/node_modules/@types/node/dom-events.d.ts:67

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
- Defined in src/bench.ts:156

remove

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

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
Overrides EventTarget.removeEventListener
- Defined in src/bench.ts:174

reset

reset(): void
reset tasks and remove their result

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

run

run(): Promise<Task[]>
run the added tasks that were registered using the add method

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

runSync

runSync(): Task[]
run the added tasks that were registered using the add method (sync version)

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

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
- Defined in src/bench.ts:244

Class Bench

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns Bench

Properties

concurrency

Optional Readonlyname

Readonlyopts

Readonlyruntime

ReadonlyruntimeVersion

threshold

Default

Accessors

results

Returns (undefined | Readonly<TaskResult>)[]

tasks

Returns Task[]

Methods

add

Parameters

Returns this

Throws

addEventListener

Type Parameters

Parameters

Returns void

dispatchEvent

Parameters

Returns boolean

getTask

Parameters

Returns undefined | Task

remove

Parameters

Returns this

removeEventListener

Type Parameters

Parameters

Returns void

reset

Returns void

run

Returns Promise<Task[]>

runSync

Returns Task[]

table

Parameters

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

Settings

On This Page

`Optional` `Readonly`name

`Readonly`opts

`Readonly`runtime

`Readonly`runtimeVersion