Class BenchFactory

The Benchmark instance for keeping track of the benchmark tasks and controlling them.

Hierarchy

Constructors

constructor

Properties

_tasks _todos iterations now setup signal? teardown throws time warmupIterations warmupTime

Accessors

results tasks todos

Methods

add addEventListener dispatchEvent getTask remove removeEventListener reset run table todo warmup

Constructors

constructor

  • new BenchFactory(options?): BenchFactory

  • Parameters

    Returns BenchFactory

Properties

_tasks

_tasks: Map<string, BenchTask>

_todos

_todos: Map<string, BenchTask>

iterations

iterations: number

now

now: (() => number)

Type declaration

    • (): number

    • Returns number

setup

setup: Hook

Optional signal

signal?: AbortSignal

teardown

teardown: Hook

throws

throws: boolean

time

time: number

warmupIterations

warmupIterations: number

warmupTime

warmupTime: number

Accessors

results

  • get results(): (undefined | BenchTaskResult)[]

  • (getter) tasks results as an array

    Returns (undefined | BenchTaskResult)[]

tasks

  • get tasks(): BenchTask[]

  • (getter) tasks as an array

    Returns BenchTask[]

todos

  • get todos(): BenchTask[]

  • Returns BenchTask[]

Methods

add

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

  • add a benchmark task to the task map

    Parameters

    • name: string
    • fn: Fn
    • Optional opts: FnOptions

    Returns this

addEventListener

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

  • Type Parameters

    • K extends BenchEvents

    • T = BenchEventsMap[K]

    Parameters

    • type: K
    • listener: T
    • Optional options: 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.

    MDN Reference

    Parameters

    Returns boolean

getTask

  • getTask(name): undefined | BenchTask

  • get a task based on the task name

    Parameters

    • name: string

    Returns undefined | BenchTask

remove

  • remove(name): this

  • remove a benchmark task from the task map

    Parameters

    • name: string

    Returns this

removeEventListener

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

  • Type Parameters

    • K extends BenchEvents

    • T = BenchEventsMap[K]

    Parameters

    • type: K
    • listener: T
    • Optional options: boolean | EventListenerOptions

    Returns void

reset

  • reset(): void

  • reset each task and remove its result

    Returns void

run

  • run(): Promise<BenchTask[]>

  • run the added tasks that were registered using the add method. Note: This method does not do any warmup. Call warmup for that.

    Returns Promise<BenchTask[]>

table

  • table(): (null | {
        Average Time (ns): string | number;
        Margin: string;
        Samples: string | number;
        Task Name: string;
        ops/sec: string;
    })[]

  • table of the tasks results

    Returns (null | {
        Average Time (ns): string | number;
        Margin: string;
        Samples: string | number;
        Task Name: string;
        ops/sec: string;
    })[]

todo

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

  • add a benchmark todo to the todo map

    Parameters

    • name: string
    • Optional fn: Fn
    • Optional opts: FnOptions

    Returns this

warmup

  • warmup(): Promise<void>

  • warmup the benchmark tasks. This is not run by default by the run method.

    Returns Promise<void>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc