tinybench - v6.2.0
    Preparing search index...

    Class Bench

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

    Hierarchy

    • EventTarget
      • Bench

    Implements

    Index
    constructor
    addEventListener concurrency iterations name now removeEventListener retainSamples runtime runtimeVersion setup signal? subtractTimerOverhead teardown threshold throws time timerOverhead? timestampProvider warmup warmupIterations warmupTime
    results tasks
    add dispatchEvent getTask remove reset run runSync table
    addEventListener: <K extends BenchEvents>(
        type: K,
        listener: EventListener<K> | EventListenerObject<K, "bench"> | null,
        options?: boolean | AddEventListenerOptions,
    ) => void & (
        type: string,
        callback: EventListenerOrEventListenerObject | 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

    concurrency: Concurrency

    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.
    iterations: number

    The iteration limit per task; see BenchOptions.iterations.

    name: string | undefined

    The benchmark name.

    now: NowFn

    A function to get a timestamp.

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

    Removes a previously registered event listener.

    Type Declaration

      • (
            type: string,
            callback: EventListenerOrEventListenerObject | null,
            options?: boolean | EventListenerOptions,
        ): void

      • The removeEventListener() method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target. The event listener to be removed is identified using a combination of the event type, the event listener function itself, and various optional options that may affect the matching process; see Matching event listeners for removal.

        MDN Reference

        Parameters

        • type: string
        • callback: EventListenerOrEventListenerObject | null
        • Optionaloptions: boolean | EventListenerOptions

        Returns void

    retainSamples: boolean

    Should samples be retained for further custom processing

    runtime: JSRuntime

    The JavaScript runtime environment.

    runtimeVersion: string

    The JavaScript runtime version.

    setup: (task: Task, mode: HookMode) => void | Promise<void>

    A setup function called once per task and phase.

    signal?: AbortSignal

    An AbortSignal to cancel the benchmark.

    subtractTimerOverhead: boolean

    Whether to subtract an estimated timestamp provider call overhead from each raw latency sample.

    Incompatible with concurrency: 'task'. Enforced at construction and re-checked at the start of Bench.run to guard against untyped (JS-side) mutation of the readonly concurrency field after construction.

    false
    teardown: (task: Task, mode: HookMode) => void | Promise<void>

    A teardown function called once per task and phase.

    threshold: number

    Maximum concurrent iterations within a task; only for concurrency: 'task'.

    Number.POSITIVE_INFINITY
    throws: boolean

    Whether to throw an error if a task function throws

    false
    time: number

    The time budget per task in milliseconds; see BenchOptions.time.

    timerOverhead?: number

    The estimated cost of one timestamp provider call in milliseconds.

    undefined when subtractTimerOverhead is false. Otherwise calibrated once at construction time via calibrateTimerOverhead.

    timestampProvider: TimestampProvider

    A timestamp provider and its related functions.

    warmup: boolean

    Whether to warmup the tasks before running them

    warmupIterations: number

    The warmup iteration limit; see BenchOptions.warmupIterations.

    warmupTime: number

    The warmup time budget in milliseconds; see BenchOptions.warmupTime.

    • get tasks(): Task[]

      The tasks as an array.

      Returns Task[]

      An array containing all benchmark tasks

    • 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

      when a task with the same name already exists

    • 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

    • 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

    • Removes a benchmark task from the task map.

      Parameters

      • name: string

        the task name

      Returns this

      the Bench instance

    • Resets each task's run count, statistics and diagnostics. Results remain available as not-started or aborted; aborted signals are not rearmed.

      Returns void

    • Runs the added benchmark tasks.

      Returns Promise<Task[]>

      the tasks array

    • Runs the added benchmark tasks synchronously.

      Returns Task[]

      the tasks array

    • 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

    Settings
    Member Visibility

    On This Page
    Constructors
    Properties
    Accessors
    Methods