test.benchmark
A wrapper over Benchmark.js to make writing benchmarks easier
Example
var Benchmark = ;var Future = ; // Synchronousvar suite = Benchmark; // Asynchronousvar asyncSuite = Benchmark; Benchmark; // Benchmarks for: Scheduling...//// o nextTick x 770 ops/sec ±0.70% (66 runs sampled)// o setImmediate x 758 ops/sec ±1.18% (86 runs sampled)// // Fastest: nextTick// Slowest: setImmediate// // ---// // Benchmarks for: Testing characters...// // o RegExp#test x 3,162,850 ops/sec ±3.20% (91 runs sampled)// o String#indexOf x 5,175,777 ops/sec ±1.69% (86 runs sampled)// // Fastest: String#indexOf// Slowest: RegExp#test// // ---// All benchmarks finished.
Installing
The easiest way is to grab it from NPM. If you're running in a Browser environment, you can use Browserify
$ npm install test.benchmark
Using with CommonJS
If you're not using NPM, Download the latest release, and require
the test.benchmark.umd.js
file:
var Benchmark =
Using with AMD
Download the latest release, and require the test.benchmark.umd.js
file:
Using without modules
Download the latest release, and load the test.benchmark.umd.js
file. The properties are exposed in the global Folktale.Test.Benchmark
object:
Compiling from source
If you want to compile this library from the source, you'll need Git, Make, Node.js, and run the following commands:
$ git clone git://github.com/folktale/test.benchmark.git
$ cd test.benchmark
$ npm install
$ make bundle
This will generate the dist/test.benchmark.umd.js
file, which you can load in
any JavaScript environment.
Documentation
You can read the documentation online or build it yourself:
$ git clone git://github.com/folktale/test.benchmark.git
$ cd test.benchmark
$ npm install
$ make documentation
Then open the file docs/index.html
in your browser.
Platform support
This library assumes an ES5 environment, but can be easily supported in ES3 platforms by the use of shims. Just include es5-shim :)
Licence
Copyright (c) 2014 Quildreen Motta.
Released under the MIT licence.