Interface BenchmarkResult

the benchmark task result object

interface BenchmarkResult {
    critical: number;
    df: number;
    error?: unknown;
    hz: number;
    max: number;
    mean: number;
    min: number;
    moe: number;
    name: string;
    p75: number;
    p99: number;
    p995: number;
    p999: number;
    period: number;
    rank: number;
    rme: number;
    samples: number[];
    sd: number;
    sem: number;
    totalTime: number;
    variance: number;
}

Hierarchy (view full)

Properties

critical df error? hz max mean min moe name p75 p99 p995 p999 period rank rme samples sd sem totalTime variance

Properties

critical

critical: number

critical value of the samples

df

df: number

degrees of freedom

Optional error

error?: unknown

hz

hz: number

the number of operations per second

max

max: number

the maximum value in the samples

mean

mean: number

samples mean/average (estimate of the population mean)

min

min: number

the minimum value in the samples

moe

moe: number

margin of error

name

name: string

p75

p75: number

p75 percentile

p99

p99: number

p99 percentile

p995

p995: number

p995 percentile

p999

p999: number

p999 percentile

period

period: number

how long each operation takes (ms)

rank

rank: number

rme

rme: number

relative margin of error

samples

samples: number[]

task samples of each task iteration time (ms)

sd

sd: number

samples standard deviation (estimate of the population standard deviation)

sem

sem: number

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

totalTime

totalTime: number

The amount of time in milliseconds to run the benchmark task (cycle).

variance

variance: number

samples variance (estimate of the population variance)

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc