simple-benchmarkjs-runner
v0.0.5
Published
An simple runner for benchmark.js
Downloads
11
Maintainers
Readme
simple-benchmarkjs-runner
A simple runner for benchmark.js. It abstracts the benchmark.js API and provides a config-like way to execute your benchmarking.
Installation
Install the lib:
$ npm install simple-benchmarkjs-runner --save-dev
Require it in your code:
import BenchmarkRunner from 'simple-benchmarkjs-runner';
// or
var BenchmarkRunner = require('simple-benchmarkjs-runner');
API
Basic usage:
import BenchmarkRunner from 'simple-benchmarkjs-runner';
import impl1 from './implementations/first';
import impl2 from './implementations/second';
new BenchmarkRunner({
title: 'benchmark-suite-title',
tests: [
{
title: 'Implementation 1',
fn: impl1
},
{
title: 'Implementation 2',
fn: () => {
impl2(someOtherData);
}
}
]
});
It also accepts an array of suite configs. They will run sequentialy:
new BenchmarkRunner([
{
title: 'benchmark-suite-title',
tests: [...]
}, {
title: 'another-benchmark-suite-title',
tests: [...]
}
]);
Execution
$ npm run benchmark
Output
It will benchmark the different implementations and it will output some stats:
Implementation 1 x 13,244 ops/sec ±6.60% (66 runs sampled)
Implementation 2 x 15,724 ops/sec ±3.05% (83 runs sampled)
Fastest is "Implementation 2"!
License
The MIT License (MIT)