benchmarked

Easily generate benchmarks from a glob of files.

Install

Install with npm:

$ npm install benchmarked --save

This is an opinionated wrapper for benchmarked.js to make it easier to do benchmarks. Concept is from remarkable

Usage

var suite = require('benchmarked')({
  cwd: 'benchmark',              // optionally define a base directory for code and fixtures
  fixtures: 'my-fixtures/*.txt', // path or glob pattern to fixtures
  code: 'my-functions/*.js'      // path or glob pattern to code files
});

// run the benchmarks
suite.run();

See the examples to get a better understanding of how this works.

API

Benchmarked

Create an instance of Benchmarked with the given options.

Params

• options {Object}

Example

var benchmarks = new Benchmarked();

.addFixtures

Add fixtures to run benchmarks against.

Params

• patterns {String|Array}: Filepaths or glob patterns.
• options {Options}

Example

benchmarks.addFixtures('fixtures/*.txt');

.addCode

Specify the functions to be benchmarked.

Params

• patterns {String|Array}: Filepath(s) or glob patterns.
• options {Options}

Example

benchmarks.addCode('fixtures/*.txt');

.addSuite

Add benchmark suite to the given fixture file.

Params

• fixture {Object}: vinyl file object

.run

Run the benchmarks.

Params

• options {Object}
• cb {Function}
• thisArg {Object}

Example

benchmarks.run();

Related projects

You might also be interested in these projects:

• base-cli: Plugin for base-methods that maps built-in methods to CLI args (also supports methods from a… more | homepage
• base-option: Adds a few options methods to base, like option, enable and disable. See the readme… more | homepage
• base-pkg: Plugin for adding a pkg method that exposes pkg-store to your base application. | homepage
• base: base is the foundation for creating modular, unit testable and highly pluggable node.js applications, starting… more | homepage

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.

Building docs

Generate readme and API documentation with verb:

$ npm install verb && npm run docs

Or, if verb is installed globally:

$ verb

Running tests

Install dev dependencies:

$ npm install -d && npm test

Author

Jon Schlinkert

• github/jonschlinkert
• twitter/jonschlinkert

License

Copyright © 2016, Jon Schlinkert. Released under the MIT license.

This file was generated by verb, v0.9.0, on May 03, 2016.