Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/mcollina/fastbench

the simplest benchmark you can run on node
https://github.com/mcollina/fastbench

Last synced: about 2 months ago
JSON representation

the simplest benchmark you can run on node

Awesome Lists containing this project

README

        

# fastbench  [![Build Status](https://travis-ci.org/mcollina/fastbench.png)](https://travis-ci.org/mcollina/fastbench)

The simplest benchmark you can run on node

## Install

```js
npm install fastbench
```

## Usage

```js
'use strict'

var bench = require('fastbench')

var run = bench([
function benchSetTimeout (done) {
setTimeout(done, 0)
},
function benchSetImmediate (done) {
setImmediate(done)
},
function benchNextTick (done) {
process.nextTick(done)
}
], 1000)

// run them two times
run(run)
```

Output:

```
benchSetTimeout*1000: 1363ms
benchSetImmediate*1000: 4ms
benchNextTick*1000: 1ms
benchSetTimeout*1000: 1365ms
benchSetImmediate*1000: 4ms
benchNextTick*1000: 0ms
```

You can disable colors by passing a `--no-color` flag to your node
script.

## API

### bench(functions, iterations)

Build a benchmark for the given functions and that precise number of
iterations. It returns a function to run the benchmark.

The iterations parameter can also be an `Object`, in which case it
acceps two options:

* `iterations`: the number of iterations (required)
* `max`: is a an alias for iterations
* `color`: if the output should have color (default: true)

## License

MIT