tinybench
Benchmark your code easily with Tinybench, a simple, tiny and light-weight 7KB
(2KB
minified and gzipped)
benchmarking library!
You can run your benchmarks in multiple JavaScript runtimes, Tinybench is
completely based on the Web APIs with proper timing using process.hrtime
or
performance.now
.
- Accurate and precise timing based on the environment
Event
and EventTarget
compatible events- Statistically analyzed values
- Calculated Percentiles
- Fully detailed results
- No dependencies
In case you need more tiny libraries like tinypool or tinyspy, please consider submitting an RFC
Installing
$ npm install -D tinybench
Usage
You can start benchmarking by instantiating the Bench
class and adding
benchmark tasks to it.
import { Bench } from 'tinybench';
const bench = new Bench({ time: 100 });
bench
.add('switch 1', () => {
let a = 1;
let b = 2;
const c = a;
a = b;
b = c;
})
.add('switch 2', () => {
let a = 1;
let b = 10;
a = b + a;
b = a - b;
a = b - a;
});
await bench.run();
console.table(bench.tasks.map(({ name, result }) => ({ "Task Name": name, "Average Time (ps)": result?.mean! * 1000, "Variance (ps)": result?.variance! * 1000 })));
The add
method accepts a task name and a task function, so it can benchmark
it! This method returns a reference to the Bench instance, so it's possible to
use it to create an another task for that instance.
Note that the task name should always be unique in an instance, because Tinybench stores the tasks based
on their names in a Map
.
Also note that tinybench
does not log any result by default. You can extract the relevant stats
from bench.tasks
or any other API after running the benchmark, and process them however you want.
Docs
Bench
The Benchmark instance for keeping track of the benchmark tasks and controlling
them.
Options:
export type Options = {
time?: number;
iterations?: number;
now?: () => number;
signal?: AbortSignal;
warmupTime?: number;
warmupIterations?: number;
setup?: Hook;
teardown?: Hook;
};
export type Hook = (task: Task, mode: "warmup" | "run") => void | Promise<void>;
async run()
: run the added tasks that were registered using the add
methodasync runSequentially()
: works like run
but runs the tasks
sequentially, see #17 for more informationasync warmup()
: warm up the benchmark tasksreset()
: reset each task and remove its resultadd(name: string, fn: Fn)
: add a benchmark task to the task map-
Fn
: () => any | Promise<any>
remove(name: string)
: remove a benchmark task from the task mapget results(): (TaskResult | undefined)[]
: (getter) tasks results as an arrayget tasks(): Task[]
: (getter) tasks as an arraygetTask(name: string): Task | undefined
: get a task based on the name
Task
A class that represents each benchmark task in Tinybench. It keeps track of the
results, name, Bench instance, the task function and the number of times the task
function has been executed.
constructor(bench: Bench, name: string, fn: Fn)
bench: Bench
name: string
: task namefn: Fn
: the task functionruns: number
: the number of times the task function has been executedresult?: TaskResult
: the result objectasync run()
: run the current task and write the results in Task.result
objectasync warmup()
: warm up the current tasksetResult(result: Partial<TaskResult>)
: change the result object valuesreset()
: reset the task to make the Task.runs
a zero-value and remove the Task.result
object
TaskResult
the benchmark task result object.
export type TaskResult = {
error?: unknown;
totalTime: number;
min: number;
max: number;
hz: number;
period: number;
samples: number[];
mean: number;
variance: number;
sd: number;
sem: number;
df: number;
critical: number;
moe: number;
rme: number;
p75: number;
p99: number;
p995: number;
p999: number;
};
Events
Both the Task
and Bench
objects extend the EventTarget
object, so you can attach listeners to different types of events
in each class instance using the universal addEventListener
and
removeEventListener
.
export type BenchEvents =
| "abort"
| "complete"
| "error"
| "reset"
| "start"
| "warmup"
| "cycle"
| "add"
| "remove";
export type TaskEvents =
| "abort"
| "complete"
| "error"
| "reset"
| "start"
| "warmup"
| "cycle";
For instance:
bench.addEventListener("cycle", (e: BenchEvent) => {
const task = e.task!;
});
task.addEventListener("cycle", (e: BenchEvent) => {
const task = e.task!;
});
BenchEvent
export type BenchEvent = Event & {
task: Task | null;
};
Prior art
Authors
Credits
Contributing
Feel free to create issues/discussions and then PRs for the project!