Class Bench

constructor

• new Bench(options?: BenchOptions): Bench

  Parameters

  • options: BenchOptions = {}

  Returns Bench

concurrency

Optional Readonlyname

Readonlyopts

Readonlyruntime

ReadonlyruntimeVersion

threshold

Number.POSITIVE_INFINITY
Copy

results

• get results(): (Readonly<TaskResult> | undefined)[]

  tasks results as an array

  Returns (Readonly<TaskResult> | undefined)[]

  the tasks results as an array

tasks

• get tasks(): Task[]

  tasks as an array

  Returns Task[]

  the tasks as an array

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

addEventListener

• addEventListener<K extends BenchEvents>(
      type: K,
      listener: BenchEventsMap[K],
      options?: boolean | AddEventListenerOptions,
  ): void

  Type Parameters

  • K extends BenchEvents

  Parameters

  • type: K
  • listener: BenchEventsMap[K]
  • Optionaloptions: boolean | AddEventListenerOptions

  Returns void

getTask

• getTask(name: string): Task | undefined

  get a task based on the task name

  Parameters

  • name: string

    the task name

  Returns Task | undefined

  the Task instance

remove

• remove(name: string): this

  remove a benchmark task from the task map

  Parameters

  • name: string

    the task name

  Returns this

  the Bench instance

removeEventListener

• removeEventListener<K extends BenchEvents>(
      type: K,
      listener: BenchEventsMap[K],
      options?: boolean | EventListenerOptions,
  ): void

  Type Parameters

  • K extends BenchEvents

  Parameters

  • type: K
  • listener: BenchEventsMap[K]
  • Optionaloptions: boolean | EventListenerOptions

  Returns void

reset

• reset(): void

  reset tasks and remove their result

  Returns void

run

• run(): Promise<Task[]>

  run the added tasks that were registered using the add method

  Returns Promise<Task[]>

  the tasks array

runSync

• runSync(): Task[]

  run the added tasks that were registered using the add method (sync version)

  Returns Task[]

  the tasks array

table

• table(
      convert?: (task: Task) => Record<string, number | string | undefined>,
  ): (Record<string, string | number | undefined> | null)[]

  table of the tasks results

  Parameters

  • Optionalconvert: (task: Task) => Record<string, number | string | undefined>

    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