Class BenchTask

A class that represents each benchmark task in Tinybench. It keeps track of the results, name, Bench instance, the task function and the number times the task function has been executed.

Hierarchy

Constructors

constructor

Properties

bench fn name opts result? runs

Methods

addEventListener dispatchEvent removeEventListener reset run setResult warmup

Constructors

constructor

  • new BenchTask(bench, name, fn, opts?): BenchTask

  • Parameters

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

    Returns BenchTask

Properties

bench

bench: BenchFactory

fn

fn: Fn

name

name: string

task name

opts

opts: FnOptions

Task options

Optional result

result?: BenchTaskResult

the result object

runs

runs: number

Methods

addEventListener

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

  • Type Parameters

    • K extends TaskEvents

    • T = TaskEventsMap[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

removeEventListener

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

  • Type Parameters

    • K extends TaskEvents

    • T = TaskEventsMap[K]

    Parameters

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

    Returns void

reset

  • reset(): void

  • reset the task to make the Task.runs a zero-value and remove the Task.result object

    Returns void

run

  • run(): Promise<BenchTask>

  • run the current task and write the results in Task.result object

    Returns Promise<BenchTask>

setResult

  • setResult(result): void

  • change the result object values

    Parameters

    Returns void

warmup

  • warmup(): Promise<void>

  • warmup the current task

    Returns Promise<void>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc