@davedoesdev/b

B - Benchmarks for Node.js

Description

B is small and elegant module for Node.js that makes benchmarking fun.

Originally written by Veselin Todorov.

Features

• Async, sync & parallel benchmarks
• Streams
• Reporters

Synopsis

Synchronous

const b = require('@davedoesdev/b');

b('Synchronous benchmark', function (i) {
  for (let i = 0, len = 1000000; i < len; ++i);
}).run(100);

Asynchronous

const b = require('@davedoesdev/b');

b('Asynchronous benchmark', function (i, done) {
  setTimeout(done, 10);
}).run(10);

Select a reporter

const b = require('@davedoesdev/b');

b('make pretty and print to console', function (i) {
  for (let i = 0, len = 1000000; i < len; ++i);
}).reporter('cli').run(100); // default

b('output json data', function (i) {
  for (let i = 0, len = 1000000; i < len; ++i);
}).reporter('json').run(100);

Build your reporter

const b = require('@davedoesdev/b');

class Reporter {
    report(name, result, iterations) {
        console.log(name, result, iterations);
    }
}

b('Custom reporter', function () {
  for (let i = 0, len = 1000000; i < len; ++i);
}).reporter(new Reporter()).run(10);

Multiple

const b = require('@davedoesdev/b');

b('sync and async')
  .add('sync', function (i) {
    const start = Date.now();
    while (Date.now() - start < 10);
  })
  .add('async', function (i, done) {
    setTimeout(done, 10);
  })
  .run(10);

Requirements

• Node.js 14+ (http://nodejs.org/)

Install

$ npm install @davedoesdev/b

Tests

$ npm install
$ make test

Contributors

 project  : b
 repo age : 10 years
 active   : 28 days
 commits  : 132
 files    : 60
 authors  :
    47	jkroso           35.6%
    34	David Halls      25.8%
    32	Veselin Todorov  24.2%
    18	Jake Rosoman     13.6%
     1	Jakeb            0.8%

License

MIT License

Copyright (C) 2012 Veselin Todorov
Copyright (C) 2022 David Halls

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.