From 3c401664bc2e91047c64244d814ee77287d6dec5 Mon Sep 17 00:00:00 2001 From: Documentation Bot Date: Wed, 13 Nov 2024 17:07:22 +0000 Subject: [PATCH] docs: publish documentation --- docs/classes/Bench.html | 38 +++++++++++----------- docs/classes/Task.html | 22 ++++++------- docs/enums/JSRuntime.html | 6 ++-- docs/functions/hrtimeNow.html | 4 +-- docs/functions/nToMs.html | 4 +-- docs/functions/now.html | 4 +-- docs/index.html | 4 +-- docs/interfaces/BenchEventsMap.html | 4 +-- docs/interfaces/FnOptions.html | 12 +++---- docs/interfaces/Options.html | 26 +++++++-------- docs/interfaces/Statistics.html | 40 +++++++++++------------ docs/interfaces/TaskEventsMap.html | 4 +-- docs/interfaces/TaskResult.html | 50 ++++++++++++++--------------- docs/types/BenchEvent.html | 4 +-- docs/types/BenchEvents.html | 4 +-- docs/types/EventListener.html | 4 +-- docs/types/Fn.html | 4 +-- docs/types/Hook.html | 2 +- docs/types/TaskEvents.html | 4 +-- 19 files changed, 120 insertions(+), 120 deletions(-) diff --git a/docs/classes/Bench.html b/docs/classes/Bench.html index 98d7972..ccac427 100644 --- a/docs/classes/Bench.html +++ b/docs/classes/Bench.html @@ -1,5 +1,5 @@ -Bench | tinybench - v3.0.4

Class Bench

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

-

Hierarchy

  • EventTarget
    • Bench

Constructors

constructor +Bench | tinybench - v3.0.5

Class Bench

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

+

Hierarchy

  • EventTarget
    • Bench

Constructors

constructor

Properties

concurrency iterations name? @@ -26,47 +26,47 @@ reset run table -

Constructors

constructor

Properties

concurrency

concurrency: null | "task" | "bench" = null

Executes tasks concurrently based on the specified concurrency mode.

+

Constructors

constructor

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.
-

iterations

iterations: number = defaultMinimumIterations

Optional Readonlyname

name?: string

The benchmark name.

-

Readonlynow

now: (() => number) = now

Type declaration

    • (): number

    • Returns the current high resolution millisecond timestamp, where 0 represents the start of the current node process.

      +

iterations

iterations: number = defaultMinimumIterations

Optional Readonlyname

name?: string

The benchmark name.

+

Readonlynow

now: (() => number) = now

Type declaration

    • (): number

    • Returns the current high resolution millisecond timestamp, where 0 represents the start of the current node process.

      Returns number

      Since

      v8.5.0

      -

Readonlyruntime

runtime: JSRuntime | "unknown"

The JavaScript runtime environment.

-

ReadonlyruntimeVersion

runtimeVersion: string

The JavaScript runtime version.

-

Readonlysetup

setup: Hook

Optional Readonlysignal

signal?: AbortSignal

Readonlyteardown

teardown: Hook

threshold

threshold: number = Number.POSITIVE_INFINITY

The maximum number of concurrent tasks to run

+

Readonlyruntime

runtime: JSRuntime | "unknown"

The JavaScript runtime environment.

+

ReadonlyruntimeVersion

runtimeVersion: string

The JavaScript runtime version.

+

Readonlysetup

setup: Hook

Optional Readonlysignal

signal?: AbortSignal

Readonlyteardown

teardown: Hook

threshold

threshold: number = Number.POSITIVE_INFINITY

The maximum number of concurrent tasks to run

Default

Number.POSITIVE_INFINITY
-

throws

throws: boolean = false

time

time: number = defaultMinimumTime

warmup

warmup: boolean = true

warmupIterations

warmupIterations: number = defaultMinimumWarmupIterations

warmupTime

warmupTime: number = defaultMinimumWarmupTime

Accessors

results

throws

throws: boolean = false

time

time: number = defaultMinimumTime

warmup

warmup: boolean = true

warmupIterations

warmupIterations: number = defaultMinimumWarmupIterations

warmupTime

warmupTime: number = defaultMinimumWarmupTime

Accessors

results

tasks

tasks

Methods

add

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

  • add a benchmark task to the task map

    +

Methods

add

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

  • add a benchmark task to the task map

    Parameters

    • name: string

      the task name

    • fn: Fn

      the task function

    • opts: FnOptions = {}

      the task options

    Returns this

    the Bench instance

    -

addEventListener

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

  • Adds a new handler for the type event. Any given listener is added only once per type and per capture option value.

    +

addEventListener

  • addEventListener<K>(type, listener, options?): 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

    Parameters

    • type: K
    • listener: BenchEventsMap[K]
    • Optionaloptions: 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.

    +

    Type Parameters

    Parameters

    • type: K
    • listener: BenchEventsMap[K]
    • Optionaloptions: 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.

    Parameters

    • event: Event

    Returns boolean

getTask

  • getTask(name): undefined | Task

  • get a task based on the task name

    Parameters

    • name: string

      the task name

    Returns undefined | Task

    the task

    -

remove

  • remove(name): this

  • remove a benchmark task from the task map

    +

remove

  • remove(name): this

  • remove a benchmark task from the task map

    Parameters

    • name: string

      the task name

    Returns this

    the Bench instance

    -

removeEventListener

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

  • Removes the event listener in target's event listener list with the same type, callback, and options.

    -

    Type Parameters

    Parameters

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

    Returns void

reset

  • reset(): void

  • reset each task and remove its result

    -

    Returns void

run

removeEventListener

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

  • Removes the event listener in target's event listener list with the same type, callback, and options.

    +

    Type Parameters

    Parameters

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

    Returns void

reset

  • reset(): void

  • reset each task and remove its result

    +

    Returns void

run

  • run(): Promise<Task[]>

  • run the added tasks that were registered using the add method

    Returns Promise<Task[]>

    the tasks array

    -

table

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

  • table of the tasks results

    +

table

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

  • table of the tasks results

    Parameters

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

      an optional callback to convert the task result to a table record

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

        • Parameters

          Returns undefined | Record<string, string | number>

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

    the tasks results as an array of table records

    -

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods
+

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods
diff --git a/docs/classes/Task.html b/docs/classes/Task.html index a871fcd..b0b2643 100644 --- a/docs/classes/Task.html +++ b/docs/classes/Task.html @@ -1,7 +1,7 @@ -Task | tinybench - v3.0.4

Class Task

A class that represents each benchmark task in Tinybench. It keeps track of the +Task | tinybench - v3.0.5

Class Task

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

-

Hierarchy

  • EventTarget
    • Task

Constructors

constructor +

Hierarchy

  • EventTarget
    • Task

Constructors

constructor

Properties

name result runs @@ -11,18 +11,18 @@ reset run warmup -

Constructors

constructor

Properties

Readonlyname

name: string

Task name

-

result

result: undefined | Readonly<TaskResult>

The result object

-

runs

runs: number = 0

The number of times the task function has been executed

-

Methods

addEventListener

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

  • Adds a new handler for the type event. Any given listener is added only once per type and per capture option value.

    +

Constructors

constructor

Properties

Readonlyname

name: string

Task name

+

result

result: undefined | Readonly<TaskResult>

The result object

+

runs

runs: number = 0

The number of times the task function has been executed

+

Methods

addEventListener

  • addEventListener<K>(type, listener, options?): 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

    Parameters

    • type: K
    • listener: TaskEventsMap[K]
    • Optionaloptions: 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.

    +

    Type Parameters

    Parameters

    • type: K
    • listener: TaskEventsMap[K]
    • Optionaloptions: 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.

    Parameters

    • event: Event

    Returns boolean

removeEventListener

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

  • Removes the event listener in target's event listener list with the same type, callback, and options.

    -

    Type Parameters

    Parameters

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

    Returns void

reset

  • reset(): void
  • Internal

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

    -

    Returns void

run

  • run(): Promise<Task>
  • Internal

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

    +

    Type Parameters

    Parameters

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

    Returns void

reset

  • reset(): void
  • Internal

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

    +

    Returns void

run

  • run(): Promise<Task>
  • Internal

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

    Returns Promise<Task>

    the current task

    -

warmup

  • warmup(): Promise<void>
  • Internal

    warmup the current task

    -

    Returns Promise<void>

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
+

warmup

  • warmup(): Promise<void>
  • Internal

    warmup the current task

    +

    Returns Promise<void>

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/docs/enums/JSRuntime.html b/docs/enums/JSRuntime.html index f49ddf3..9b67b50 100644 --- a/docs/enums/JSRuntime.html +++ b/docs/enums/JSRuntime.html @@ -1,6 +1,6 @@ -JSRuntime | tinybench - v3.0.4

Enumeration JSRuntime

The JavaScript runtime environment.

+JSRuntime | tinybench - v3.0.5

Enumeration JSRuntime

The JavaScript runtime environment.

See

https://runtime-keys.proposal.wintercg.org/

-

Enumeration Members

browser +

Enumeration Members

browser bun deno edge-light @@ -15,4 +15,4 @@ spidermonkey v8 workerd -

Enumeration Members

browser

browser

bun

bun

deno

deno

edge-light

edge-light

fastly

fastly

hermes

hermes

jsc

jsc

lagon

lagon

moddable

moddable

netlify

netlify

node

node

quickjs-ng

quickjs-ng

spidermonkey

spidermonkey

v8

v8

workerd

workerd

Settings

Member Visibility

On This Page

Enumeration Members
+

Enumeration Members

browser

browser

bun

bun

deno

deno

edge-light

edge-light

fastly

fastly

hermes

hermes

jsc

jsc

lagon

lagon

moddable

moddable

netlify

netlify

node

node

quickjs-ng

quickjs-ng

spidermonkey

spidermonkey

v8

v8

workerd

workerd

Settings

Member Visibility

On This Page

Enumeration Members
diff --git a/docs/functions/hrtimeNow.html b/docs/functions/hrtimeNow.html index 7566f65..6036e83 100644 --- a/docs/functions/hrtimeNow.html +++ b/docs/functions/hrtimeNow.html @@ -1,3 +1,3 @@ -hrtimeNow | tinybench - v3.0.4

Function hrtimeNow

Returns the current high resolution timestamp in milliseconds using process.hrtime.bigint().

+hrtimeNow | tinybench - v3.0.5

Function hrtimeNow

Returns the current high resolution timestamp in milliseconds using process.hrtime.bigint().

  • hrtimeNow(): number

  • Returns number

    the current high resolution timestamp in milliseconds

    -

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/docs/functions/nToMs.html b/docs/functions/nToMs.html index eb15cc5..311952b 100644 --- a/docs/functions/nToMs.html +++ b/docs/functions/nToMs.html @@ -1,4 +1,4 @@ -nToMs | tinybench - v3.0.4

Function nToMs

Converts nanoseconds to milliseconds.

+nToMs | tinybench - v3.0.5

Function nToMs

Converts nanoseconds to milliseconds.

  • nToMs(ns): number

  • Parameters

    • ns: number

      the nanoseconds to convert

    Returns number

    the milliseconds

    -

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/docs/functions/now.html b/docs/functions/now.html index 2cacf23..245b71e 100644 --- a/docs/functions/now.html +++ b/docs/functions/now.html @@ -1,3 +1,3 @@ -now | tinybench - v3.0.4

Function now

  • now(): number

  • Returns the current high resolution millisecond timestamp, where 0 represents the start of the current node process.

    +now | tinybench - v3.0.5

    Function now

    • now(): number

    • Returns the current high resolution millisecond timestamp, where 0 represents the start of the current node process.

      Returns number

      Since

      v8.5.0

      -

    Settings

    Member Visibility
    +

Settings

Member Visibility
diff --git a/docs/index.html b/docs/index.html index 24e3041..3773cd0 100644 --- a/docs/index.html +++ b/docs/index.html @@ -1,4 +1,4 @@ -tinybench - v3.0.4

tinybench - v3.0.4

Index

Enumerations

JSRuntime +tinybench - v3.0.5

tinybench - v3.0.5

Index

Enumerations

JSRuntime

Classes

Bench Task

Interfaces

BenchEventsMap @@ -16,4 +16,4 @@

Functions

hrtimeNow now nToMs -

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/docs/interfaces/BenchEventsMap.html b/docs/interfaces/BenchEventsMap.html index e3b1468..0b4020d 100644 --- a/docs/interfaces/BenchEventsMap.html +++ b/docs/interfaces/BenchEventsMap.html @@ -1,4 +1,4 @@ -BenchEventsMap | tinybench - v3.0.4

Interface BenchEventsMap

interface BenchEventsMap {
    abort: EventListener;
    add: EventListener;
    complete: EventListener;
    cycle: EventListener;
    error: EventListener;
    remove: EventListener;
    reset: EventListener;
    start: EventListener;
    warmup: EventListener;
}

Properties

abort +BenchEventsMap | tinybench - v3.0.5

Interface BenchEventsMap

interface BenchEventsMap {
    abort: EventListener;
    add: EventListener;
    complete: EventListener;
    cycle: EventListener;
    error: EventListener;
    remove: EventListener;
    reset: EventListener;
    start: EventListener;
    warmup: EventListener;
}

Properties

abort add complete cycle @@ -7,4 +7,4 @@ reset start warmup -

Properties

abort

abort: EventListener

add

add: EventListener

complete

complete: EventListener

cycle

cycle: EventListener

error

error: EventListener

remove

remove: EventListener

reset

reset: EventListener

start

start: EventListener

warmup

warmup: EventListener

Settings

Member Visibility

On This Page

Properties
+

Properties

abort

abort: EventListener

add

add: EventListener

complete

complete: EventListener

cycle

cycle: EventListener

error

error: EventListener

remove

remove: EventListener

reset

reset: EventListener

start

start: EventListener

warmup

warmup: EventListener

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/interfaces/FnOptions.html b/docs/interfaces/FnOptions.html index 1728ff4..3caef27 100644 --- a/docs/interfaces/FnOptions.html +++ b/docs/interfaces/FnOptions.html @@ -1,10 +1,10 @@ -FnOptions | tinybench - v3.0.4

Interface FnOptions

the task function options

-
interface FnOptions {
    afterAll?: ((this: Task) => void | Promise<void>);
    afterEach?: ((this: Task) => void | Promise<void>);
    beforeAll?: ((this: Task) => void | Promise<void>);
    beforeEach?: ((this: Task) => void | Promise<void>);
}

Properties

afterAll? +FnOptions | tinybench - v3.0.5

Interface FnOptions

the task function options

+
interface FnOptions {
    afterAll?: ((this: Task) => void | Promise<void>);
    afterEach?: ((this: Task) => void | Promise<void>);
    beforeAll?: ((this: Task) => void | Promise<void>);
    beforeEach?: ((this: Task) => void | Promise<void>);
}

Properties

afterAll? afterEach? beforeAll? beforeEach?

Properties

OptionalafterAll

afterAll?: ((this: Task) => void | Promise<void>)

An optional function that is run after all iterations of this task end

-

OptionalafterEach

afterEach?: ((this: Task) => void | Promise<void>)

An optional function that is run after each iteration of this task

-

OptionalbeforeAll

beforeAll?: ((this: Task) => void | Promise<void>)

An optional function that is run before iterations of this task begin

-

OptionalbeforeEach

beforeEach?: ((this: Task) => void | Promise<void>)

An optional function that is run before each iteration of this task

-

Settings

Member Visibility

On This Page

Properties
+

OptionalafterEach

afterEach?: ((this: Task) => void | Promise<void>)

An optional function that is run after each iteration of this task

+

OptionalbeforeAll

beforeAll?: ((this: Task) => void | Promise<void>)

An optional function that is run before iterations of this task begin

+

OptionalbeforeEach

beforeEach?: ((this: Task) => void | Promise<void>)

An optional function that is run before each iteration of this task

+

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/interfaces/Options.html b/docs/interfaces/Options.html index c371dc4..44ae06d 100644 --- a/docs/interfaces/Options.html +++ b/docs/interfaces/Options.html @@ -1,5 +1,5 @@ -Options | tinybench - v3.0.4

Interface Options

bench options

-
interface Options {
    iterations?: number;
    name?: string;
    now?: (() => number);
    setup?: Hook;
    signal?: AbortSignal;
    teardown?: Hook;
    throws?: boolean;
    time?: number;
    warmup?: boolean;
    warmupIterations?: number;
    warmupTime?: number;
}

Properties

iterations? +Options | tinybench - v3.0.5

Interface Options

bench options

+
interface Options {
    iterations?: number;
    name?: string;
    now?: (() => number);
    setup?: Hook;
    signal?: AbortSignal;
    teardown?: Hook;
    throws?: boolean;
    time?: number;
    warmup?: boolean;
    warmupIterations?: number;
    warmupTime?: number;
}

Properties

iterations? name? now? setup? @@ -14,29 +14,29 @@

Default

64
-

Optionalname

name?: string

benchmark name

-

Optionalnow

now?: (() => number)

function to get the current timestamp in milliseconds

-

Optionalsetup

setup?: Hook

setup function to run before each benchmark task (cycle)

-

Optionalsignal

signal?: AbortSignal

An AbortSignal for aborting the benchmark

-

Optionalteardown

teardown?: Hook

teardown function to run after each benchmark task (cycle)

-

Optionalthrows

throws?: boolean

Throws if a task fails

+

Optionalname

name?: string

benchmark name

+

Optionalnow

now?: (() => number)

function to get the current timestamp in milliseconds

+

Optionalsetup

setup?: Hook

setup function to run before each benchmark task (cycle)

+

Optionalsignal

signal?: AbortSignal

An AbortSignal for aborting the benchmark

+

Optionalteardown

teardown?: Hook

teardown function to run after each benchmark task (cycle)

+

Optionalthrows

throws?: boolean

Throws if a task fails

Default

false
-

Optionaltime

time?: number

time needed for running a benchmark task (milliseconds)

+

Optionaltime

time?: number

time needed for running a benchmark task (milliseconds)

Default

1000
-

Optionalwarmup

warmup?: boolean

warmup benchmark

+

Optionalwarmup

warmup?: boolean

warmup benchmark

Default

true
-

OptionalwarmupIterations

warmupIterations?: number

warmup iterations

+

OptionalwarmupIterations

warmupIterations?: number

warmup iterations

Default

16
-

OptionalwarmupTime

warmupTime?: number

warmup time (milliseconds)

+

OptionalwarmupTime

warmupTime?: number

warmup time (milliseconds)

Default

250
-

Settings

Member Visibility

On This Page

Properties
+

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/interfaces/Statistics.html b/docs/interfaces/Statistics.html index f393b1f..fdf9ca8 100644 --- a/docs/interfaces/Statistics.html +++ b/docs/interfaces/Statistics.html @@ -1,5 +1,5 @@ -Statistics | tinybench - v3.0.4

Interface Statistics

the statistics object

-
interface Statistics {
    aad: undefined | number;
    critical: number;
    df: number;
    mad: undefined | number;
    max: number;
    mean: number;
    min: number;
    moe: number;
    p50: undefined | number;
    p75: undefined | number;
    p99: undefined | number;
    p995: undefined | number;
    p999: undefined | number;
    rme: number;
    samples: number[];
    sd: number;
    sem: number;
    variance: number;
}

Properties

aad +Statistics | tinybench - v3.0.5

Interface Statistics

the statistics object

+
interface Statistics {
    aad: undefined | number;
    critical: number;
    df: number;
    mad: undefined | number;
    max: number;
    mean: number;
    min: number;
    moe: number;
    p50: undefined | number;
    p75: undefined | number;
    p99: undefined | number;
    p995: undefined | number;
    p999: undefined | number;
    rme: number;
    samples: number[];
    sd: number;
    sem: number;
    variance: number;
}

Properties

aad critical df mad @@ -18,21 +18,21 @@ sem variance

Properties

aad

aad: undefined | number

mean/average absolute deviation

-

critical

critical: number

critical value

-

df

df: number

degrees of freedom

-

mad

mad: undefined | number

median absolute deviation

-

max

max: number

the maximum value

-

mean

mean: number

mean/average

-

min

min: number

the minimum value

-

moe

moe: number

margin of error

-

p50

p50: undefined | number

p50/median percentile

-

p75

p75: undefined | number

p75 percentile

-

p99

p99: undefined | number

p99 percentile

-

p995

p995: undefined | number

p995 percentile

-

p999

p999: undefined | number

p999 percentile

-

rme

rme: number

relative margin of error

-

samples

samples: number[]

samples

-

sd

sd: number

standard deviation

-

sem

sem: number

standard error of the mean/average (a.k.a. the standard deviation of the distribution of the sample mean/average)

-

variance

variance: number

variance

-

Settings

Member Visibility

On This Page

Properties
+

critical

critical: number

critical value

+

df

df: number

degrees of freedom

+

mad

mad: undefined | number

median absolute deviation

+

max

max: number

the maximum value

+

mean

mean: number

mean/average

+

min

min: number

the minimum value

+

moe

moe: number

margin of error

+

p50

p50: undefined | number

p50/median percentile

+

p75

p75: undefined | number

p75 percentile

+

p99

p99: undefined | number

p99 percentile

+

p995

p995: undefined | number

p995 percentile

+

p999

p999: undefined | number

p999 percentile

+

rme

rme: number

relative margin of error

+

samples

samples: number[]

samples

+

sd

sd: number

standard deviation

+

sem

sem: number

standard error of the mean/average (a.k.a. the standard deviation of the distribution of the sample mean/average)

+

variance

variance: number

variance

+

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/interfaces/TaskEventsMap.html b/docs/interfaces/TaskEventsMap.html index b8b2c1b..0acad88 100644 --- a/docs/interfaces/TaskEventsMap.html +++ b/docs/interfaces/TaskEventsMap.html @@ -1,8 +1,8 @@ -TaskEventsMap | tinybench - v3.0.4

Interface TaskEventsMap

interface TaskEventsMap {
    abort: EventListener;
    complete: EventListener;
    cycle: EventListener;
    error: EventListener;
    reset: EventListener;
    start: EventListener;
    warmup: EventListener;
}

Properties

abort +TaskEventsMap | tinybench - v3.0.5

Interface TaskEventsMap

interface TaskEventsMap {
    abort: EventListener;
    complete: EventListener;
    cycle: EventListener;
    error: EventListener;
    reset: EventListener;
    start: EventListener;
    warmup: EventListener;
}

Properties

abort complete cycle error reset start warmup -

Properties

abort

abort: EventListener

complete

complete: EventListener

cycle

cycle: EventListener

error

error: EventListener

reset

reset: EventListener

start

start: EventListener

warmup

warmup: EventListener

Settings

Member Visibility

On This Page

Properties
+

Properties

abort

abort: EventListener

complete

complete: EventListener

cycle

cycle: EventListener

error

error: EventListener

reset

reset: EventListener

start

start: EventListener

warmup

warmup: EventListener

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/interfaces/TaskResult.html b/docs/interfaces/TaskResult.html index b70ee95..b2dca56 100644 --- a/docs/interfaces/TaskResult.html +++ b/docs/interfaces/TaskResult.html @@ -1,5 +1,5 @@ -TaskResult | tinybench - v3.0.4

Interface TaskResult

the task result object

-
interface TaskResult {
    critical: number;
    df: number;
    error?: Error;
    hz: number;
    latency: Statistics;
    max: number;
    mean: number;
    min: number;
    moe: number;
    p75: number;
    p99: number;
    p995: number;
    p999: number;
    period: number;
    rme: number;
    runtime: JSRuntime | "unknown";
    runtimeVersion: string;
    samples: number[];
    sd: number;
    sem: number;
    throughput: Statistics;
    totalTime: number;
    variance: number;
}

Properties

critical +TaskResult | tinybench - v3.0.5

Interface TaskResult

the task result object

+
interface TaskResult {
    critical: number;
    df: number;
    error?: Error;
    hz: number;
    latency: Statistics;
    max: number;
    mean: number;
    min: number;
    moe: number;
    p75: number;
    p99: number;
    p995: number;
    p999: number;
    period: number;
    rme: number;
    runtime: JSRuntime | "unknown";
    runtimeVersion: string;
    samples: number[];
    sd: number;
    sem: number;
    throughput: Statistics;
    totalTime: number;
    variance: number;
}

Properties

critical df error? hz @@ -24,41 +24,41 @@ variance

Properties

critical

critical: number

the latency samples critical value

Deprecated

use .latency.critical instead

-

df

df: number

the latency samples degrees of freedom

+

df

df: number

the latency samples degrees of freedom

Deprecated

use .latency.df instead

-

Optionalerror

error?: Error

the last task error that was thrown

-

hz

hz: number

the number of operations per second

+

Optionalerror

error?: Error

the last task error that was thrown

+

hz

hz: number

the number of operations per second

Deprecated

use .throughput.mean instead

-

latency

latency: Statistics

the task latency statistics

-

max

max: number

the maximum latency samples value

+

latency

latency: Statistics

the task latency statistics

+

max

max: number

the maximum latency samples value

Deprecated

use .latency.max instead

-

mean

mean: number

the latency samples mean/average

+

mean

mean: number

the latency samples mean/average

Deprecated

use .latency.mean instead

-

min

min: number

the minimum latency samples value

+

min

min: number

the minimum latency samples value

Deprecated

use .latency.min instead

-

moe

moe: number

the latency samples margin of error

+

moe

moe: number

the latency samples margin of error

Deprecated

use .latency.moe instead

-

p75

p75: number

the latency samples p75 percentile

+

p75

p75: number

the latency samples p75 percentile

Deprecated

use .latency.p75 instead

-

p99

p99: number

the latency samples p99 percentile

+

p99

p99: number

the latency samples p99 percentile

Deprecated

use .latency.p99 instead

-

p995

p995: number

the latency samples p995 percentile

+

p995

p995: number

the latency samples p995 percentile

Deprecated

use .latency.p995 instead

-

p999

p999: number

the latency samples p999 percentile

+

p999

p999: number

the latency samples p999 percentile

Deprecated

use .latency.p999 instead

-

period

period: number

how long each operation takes (ms)

-

rme

rme: number

the latency samples relative margin of error

+

period

period: number

how long each operation takes (ms)

+

rme

rme: number

the latency samples relative margin of error

Deprecated

use .latency.rme instead

-

runtime

runtime: JSRuntime | "unknown"

the JavaScript runtime environment

-

runtimeVersion

runtimeVersion: string

the JavaScript runtime version

-

samples

samples: number[]

latency samples (ms)

+

runtime

runtime: JSRuntime | "unknown"

the JavaScript runtime environment

+

runtimeVersion

runtimeVersion: string

the JavaScript runtime version

+

samples

samples: number[]

latency samples (ms)

Deprecated

use .latency.samples instead

-

sd

sd: number

the latency samples standard deviation

+

sd

sd: number

the latency samples standard deviation

Deprecated

use .latency.sd instead

-

sem

sem: number

the latency standard error of the mean (a.k.a. the standard deviation of the distribution of the sample mean/average)

+

sem

sem: number

the latency standard error of the mean (a.k.a. the standard deviation of the distribution of the sample mean/average)

Deprecated

use .latency.sem instead

-

throughput

throughput: Statistics

the task throughput statistics

-

totalTime

totalTime: number

the time to run the task benchmark cycle (ms)

-

variance

variance: number

the latency samples variance

+

throughput

throughput: Statistics

the task throughput statistics

+

totalTime

totalTime: number

the time to run the task benchmark cycle (ms)

+

variance

variance: number

the latency samples variance

Deprecated

use .latency.variance instead

-

Settings

Member Visibility

On This Page

Properties
+

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/types/BenchEvent.html b/docs/types/BenchEvent.html index 9a3f32c..3d5d74a 100644 --- a/docs/types/BenchEvent.html +++ b/docs/types/BenchEvent.html @@ -1,2 +1,2 @@ -BenchEvent | tinybench - v3.0.4

Type Alias BenchEvent

BenchEvent: {
    error?: Error;
    task?: Task;
} & Event

bench event

-

Settings

Member Visibility
+BenchEvent | tinybench - v3.0.5

Type Alias BenchEvent

BenchEvent: {
    error?: Error;
    task?: Task;
} & Event

bench event

+

Settings

Member Visibility
diff --git a/docs/types/BenchEvents.html b/docs/types/BenchEvents.html index 267532f..6fe938e 100644 --- a/docs/types/BenchEvents.html +++ b/docs/types/BenchEvents.html @@ -1,2 +1,2 @@ -BenchEvents | tinybench - v3.0.4

Type Alias BenchEvents

BenchEvents:
    | "abort"
    | "add"
    | "complete"
    | "cycle"
    | "error"
    | "remove"
    | "reset"
    | "start"
    | "warmup"

Bench events

-

Settings

Member Visibility
+BenchEvents | tinybench - v3.0.5

Type Alias BenchEvents

BenchEvents:
    | "abort"
    | "add"
    | "complete"
    | "cycle"
    | "error"
    | "remove"
    | "reset"
    | "start"
    | "warmup"

Bench events

+

Settings

Member Visibility
diff --git a/docs/types/EventListener.html b/docs/types/EventListener.html index d42b0d2..682aa65 100644 --- a/docs/types/EventListener.html +++ b/docs/types/EventListener.html @@ -1,2 +1,2 @@ -EventListener | tinybench - v3.0.4

Type Alias EventListener

EventListener: ((evt: BenchEvent) => void)

event listener

-

Settings

Member Visibility
+EventListener | tinybench - v3.0.5

Type Alias EventListener

EventListener: ((evt: BenchEvent) => void)

event listener

+

Settings

Member Visibility
diff --git a/docs/types/Fn.html b/docs/types/Fn.html index a2147db..9c7628a 100644 --- a/docs/types/Fn.html +++ b/docs/types/Fn.html @@ -1,2 +1,2 @@ -Fn | tinybench - v3.0.4

Type Alias Fn

Fn: (() => Promise<unknown> | unknown)

the task function

-

Settings

Member Visibility
+Fn | tinybench - v3.0.5

Type Alias Fn

Fn: (() => Promise<unknown> | unknown)

the task function

+

Settings

Member Visibility
diff --git a/docs/types/Hook.html b/docs/types/Hook.html index 94b2756..5dcb745 100644 --- a/docs/types/Hook.html +++ b/docs/types/Hook.html @@ -1 +1 @@ -Hook | tinybench - v3.0.4

Type Alias Hook

Hook: ((task: Task, mode: "run" | "warmup") => Promise<void> | void)

Settings

Member Visibility
+Hook | tinybench - v3.0.5

Type Alias Hook

Hook: ((task: Task, mode: "run" | "warmup") => Promise<void> | void)

Settings

Member Visibility
diff --git a/docs/types/TaskEvents.html b/docs/types/TaskEvents.html index a724b05..794d666 100644 --- a/docs/types/TaskEvents.html +++ b/docs/types/TaskEvents.html @@ -1,2 +1,2 @@ -TaskEvents | tinybench - v3.0.4

Type Alias TaskEvents

TaskEvents:
    | "abort"
    | "complete"
    | "cycle"
    | "error"
    | "reset"
    | "start"
    | "warmup"

task events

-

Settings

Member Visibility
+TaskEvents | tinybench - v3.0.5

Type Alias TaskEvents

TaskEvents:
    | "abort"
    | "complete"
    | "cycle"
    | "error"
    | "reset"
    | "start"
    | "warmup"

task events

+

Settings

Member Visibility