Easily generate benchmarks from a glob of files.
Follow this project's author, Jon Schlinkert, for updates on this project and others.
Install with npm:
$ npm install --save benchmarkedThis is an opinionated wrapper for benchmarked.js to make it easier to do benchmarks using glob patterns. Concept is from remarkable
const Suite = require('benchmarked');
const suite = new Suite({
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
format: function(benchmark) {
// optionally override default formatting.
// return a string.
// see examples/basic.js for a real example.
}
});
// run the benchmarks
suite.run();See the examples to get a better understanding of how this works.
Create an instance of Benchmarked with the given options.
Params
options{Object}
Example
const suite = new Suite();Add fixtures to run benchmarks against.
Params
patterns{String|Array}: Filepaths or glob patterns.options{Options}
Example
benchmarks.addFixtures('fixtures/*.txt');Specify the functions to be benchmarked.
Params
patterns{String|Array}: Filepath(s) or glob patterns.options{Options}
Example
benchmarks.addCode('fixtures/*.txt');Add benchmark suite to the given fixture file.
Params
fixture{Object}: vinyl file object
Run the benchmarks.
Params
options{Object}cb{Function}thisArg{Object}
Example
benchmarks.run();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,enableanddisable. See the readme… more | homepage - base-pkg: Plugin for adding a
pkgmethod that exposes pkg-store to your base application. | homepage - base: Framework for rapidly creating high quality node.js applications, using plugins like building blocks | homepage
Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.
| Commits | Contributor |
|---|---|
| 41 | jonschlinkert |
| 7 | elidoran |
| 2 | jamescostian |
| 1 | leesei |
(This project's readme.md is generated by verb, please don't edit the readme directly. Any changes to the readme must be made in the .verb.md readme template.)
To generate the readme, run the following command:
$ npm install -g verbose/verb#dev verb-generate-readme && verbRunning and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:
$ npm install && npm testJon Schlinkert
Copyright © 2017, Jon Schlinkert. Released under the MIT License.
This file was generated by verb-generate-readme, v0.6.0, on September 11, 2017.