What is benchmark?
The 'benchmark' npm package is a library for benchmarking JavaScript code. It provides a simple and flexible API to measure the performance of code snippets, allowing developers to compare the speed of different implementations and optimize their code.
What are benchmark's main functionalities?
Basic Benchmarking
This feature allows you to create a suite of benchmarks to compare the performance of different code snippets. The example demonstrates how to add tests, attach listeners for cycle and completion events, and run the suite asynchronously.
const Benchmark = require('benchmark');
const suite = new Benchmark.Suite;
// add tests
suite.add('RegExp#test', function() {
/o/.test('Hello World!');
})
.add('String#indexOf', function() {
'Hello World!'.indexOf('o') > -1;
})
// add listeners
.on('cycle', function(event) {
console.log(String(event.target));
})
.on('complete', function() {
console.log('Fastest is ' + this.filter('fastest').map('name'));
})
// run async
.run({ 'async': true });
Event Handling
This feature allows you to handle various events during the benchmarking process, such as 'start', 'cycle', 'complete', etc. The example shows how to attach event listeners to a benchmark suite.
const Benchmark = require('benchmark');
const suite = new Benchmark.Suite;
suite.add('Example Test', function() {
// code to benchmark
})
.on('start', function() {
console.log('Benchmark started');
})
.on('complete', function() {
console.log('Benchmark completed');
})
.run();
Customizing Benchmark Options
This feature allows you to customize various options for your benchmarks, such as the minimum number of samples. The example demonstrates how to set the 'minSamples' option for a benchmark test.
const Benchmark = require('benchmark');
const suite = new Benchmark.Suite;
suite.add('Example Test', function() {
// code to benchmark
}, {
'minSamples': 100
})
.run();
Other packages similar to benchmark
fastest
The 'fastest' package is another benchmarking tool for JavaScript. It focuses on providing a simple API for running benchmarks and comparing the performance of different code snippets. Compared to 'benchmark', 'fastest' is more lightweight and may be easier to use for simple benchmarking tasks.
matcha
The 'matcha' package is a powerful benchmarking library for Node.js. It provides a command-line interface and a flexible API for writing and running benchmarks. 'matcha' offers more advanced features and a more comprehensive reporting system compared to 'benchmark'.
benchmarkjs
The 'benchmarkjs' package is a fork of the 'benchmark' library with additional features and improvements. It aims to provide a more modern and feature-rich benchmarking tool while maintaining compatibility with the original 'benchmark' API.
Benchmark.js
A robust benchmarking library that works on nearly all JavaScript platforms, supports high-resolution timers, and returns statistically significant results. As seen on jsPerf.
Documentation
The documentation for Benchmark.js can be viewed here: http://benchmarkjs.com/docs
For a list of upcoming features, check out our roadmap.
Installation and usage
In a browser or Adobe AIR:
<script src="benchmark.js"></script>
Optionally, expose Java’s nanosecond timer by adding the nano
applet to the <body>
:
<applet code="nano" archive="nano.jar"></applet>
Or enable Chrome’s microsecond timer by using the command line switch:
--enable-benchmarking
Via npm:
npm install benchmark
In Node.js:
var Benchmark = require('benchmark');
Optionally, use the microtime module by Wade Simmons:
npm install microtime
In Narwhal and RingoJS:
var Benchmark = require('benchmark').Benchmark;
In Rhino:
load('benchmark.js');
Usage example:
var suite = new Benchmark.Suite;
// add tests
suite.add('RegExp#test', function() {
/o/.test('Hello World!');
})
.add('String#indexOf', function() {
'Hello World!'.indexOf('o') > -1;
})
// add listeners
.on('cycle', function(bench) {
console.log(String(bench));
})
.on('complete', function() {
console.log('Fastest is ' + this.filter('fastest').pluck('name'));
})
// run async
.run(true);
// logs:
// > RegExp#test × 4,161,532 ±0.99% (59 cycles)
// > String#indexOf × 6,139,623 ±1.00% (131 cycles)
// > Fastest is String#indexOf
Cloning this repo
To clone this repository including all submodules, using git 1.6.5 or later:
git clone --recursive https://github.com/mathiasbynens/Benchmark.js.git
For older git versions, just use:
git clone https://github.com/mathiasbynens/Benchmark.js.git
cd Benchmark.js
git submodule update --init
Feel free to fork if you see possible improvements!
Authors
Contributors