diff --git a/README.md b/README.md index 89e1faa4..2b786880 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# Benchmark.js v2.1.2 +# Benchmark.js v2.1.3 A [robust](https://mathiasbynens.be/notes/javascript-benchmarking "Bulletproof JavaScript benchmarks") benchmarking library that supports high-resolution timers & returns statistically significant results. As seen on [jsPerf](https://jsperf.com/). @@ -8,7 +8,7 @@ A [robust](https://mathiasbynens.be/notes/javascript-benchmarking "Bulletproof J ## Download - * [Development source](https://raw.githubusercontent.com/bestiejs/benchmark.js/2.1.2/benchmark.js) + * [Development source](https://raw.githubusercontent.com/bestiejs/benchmark.js/2.1.3/benchmark.js) ## Installation diff --git a/benchmark.js b/benchmark.js index 40fffac2..e90ad529 100644 --- a/benchmark.js +++ b/benchmark.js @@ -2294,7 +2294,7 @@ * @memberOf Benchmark * @type string */ - 'version': '2.1.2' + 'version': '2.1.3' }); _.assign(Benchmark, { diff --git a/doc/README.md b/doc/README.md index 8a7ea579..060329d5 100644 --- a/doc/README.md +++ b/doc/README.md @@ -1,4 +1,4 @@ -# Benchmark.js v2.1.1 +# Benchmark.js v2.1.3 @@ -111,8 +111,8 @@ -### `Benchmark(name, fn, [options={}])` -[#](#benchmarkname-fn-options) [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/2.1.1/benchmark.js#L356 "View in source") [Ⓣ][1] +

Benchmark(name, fn, [options={}])

+[Ⓢ](https://github.com/bestiejs/benchmark.js/blob/2.1.3/benchmark.js#L356 "View in source") [Ⓣ][1] The Benchmark constructor.
@@ -202,8 +202,8 @@ var bench = new Benchmark('foo', function() { -### `Benchmark.Deferred(clone)` -[#](#benchmarkdeferredclone) [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/2.1.1/benchmark.js#L399 "View in source") [Ⓣ][1] +

Benchmark.Deferred(clone)

+[Ⓢ](https://github.com/bestiejs/benchmark.js/blob/2.1.3/benchmark.js#L399 "View in source") [Ⓣ][1] The Deferred constructor. @@ -216,8 +216,8 @@ The Deferred constructor. -### `Benchmark.Deferred.prototype.resolve()` -[#](#benchmarkdeferredprototyperesolve) [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/2.1.1/benchmark.js#L716 "View in source") [Ⓣ][1] +

Benchmark.Deferred.prototype.resolve()

+[Ⓢ](https://github.com/bestiejs/benchmark.js/blob/2.1.3/benchmark.js#L716 "View in source") [Ⓣ][1] Handles cycling/completing the deferred benchmark. @@ -227,8 +227,8 @@ Handles cycling/completing the deferred benchmark. -### `Benchmark.Event(type)` -[#](#benchmarkeventtype) [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/2.1.1/benchmark.js#L415 "View in source") [Ⓣ][1] +

Benchmark.Event(type)

+[Ⓢ](https://github.com/bestiejs/benchmark.js/blob/2.1.3/benchmark.js#L415 "View in source") [Ⓣ][1] The Event constructor. @@ -241,8 +241,8 @@ The Event constructor. -### `Benchmark.Suite(name, [options={}])` -[#](#benchmarksuitename-options) [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/2.1.1/benchmark.js#L467 "View in source") [Ⓣ][1] +

Benchmark.Suite(name, [options={}])

+[Ⓢ](https://github.com/bestiejs/benchmark.js/blob/2.1.3/benchmark.js#L467 "View in source") [Ⓣ][1] The Suite constructor.
@@ -292,8 +292,8 @@ var suite = new Benchmark.Suite('foo', { -### `Benchmark.Suite.prototype.abort()` -[#](#benchmarksuiteprototypeabort) [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/2.1.1/benchmark.js#L1008 "View in source") [Ⓣ][1] +

Benchmark.Suite.prototype.abort()

+[Ⓢ](https://github.com/bestiejs/benchmark.js/blob/2.1.3/benchmark.js#L1008 "View in source") [Ⓣ][1] Aborts all benchmarks in the suite. @@ -306,8 +306,8 @@ Aborts all benchmarks in the suite. -### `Benchmark.Suite.prototype.add(name, fn, [options={}])` -[#](#benchmarksuiteprototypeaddname-fn-options) [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/2.1.1/benchmark.js#L1068 "View in source") [Ⓣ][1] +

Benchmark.Suite.prototype.add(name, fn, [options={}])

+[Ⓢ](https://github.com/bestiejs/benchmark.js/blob/2.1.3/benchmark.js#L1068 "View in source") [Ⓣ][1] Adds a test to the benchmark suite. @@ -354,8 +354,8 @@ suite.add({ -### `Benchmark.Suite.prototype.clone(options)` -[#](#benchmarksuiteprototypecloneoptions) [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/2.1.1/benchmark.js#L1087 "View in source") [Ⓣ][1] +

Benchmark.Suite.prototype.clone(options)

+[Ⓢ](https://github.com/bestiejs/benchmark.js/blob/2.1.3/benchmark.js#L1087 "View in source") [Ⓣ][1] Creates a new suite with cloned benchmarks. @@ -371,8 +371,8 @@ Creates a new suite with cloned benchmarks. -### `Benchmark.Suite.prototype.filter(callback)` -[#](#benchmarksuiteprototypefiltercallback) [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/2.1.1/benchmark.js#L1110 "View in source") [Ⓣ][1] +

Benchmark.Suite.prototype.filter(callback)

+[Ⓢ](https://github.com/bestiejs/benchmark.js/blob/2.1.3/benchmark.js#L1110 "View in source") [Ⓣ][1] An `Array#filter` like method. @@ -388,8 +388,8 @@ An `Array#filter` like method. -### `Benchmark.Suite.prototype.reset()` -[#](#benchmarksuiteprototypereset) [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/2.1.1/benchmark.js#L1125 "View in source") [Ⓣ][1] +

Benchmark.Suite.prototype.reset()

+[Ⓢ](https://github.com/bestiejs/benchmark.js/blob/2.1.3/benchmark.js#L1125 "View in source") [Ⓣ][1] Resets all benchmarks in the suite. @@ -402,8 +402,8 @@ Resets all benchmarks in the suite. -### `Benchmark.Suite.prototype.run([options={}])` -[#](#benchmarksuiteprototyperunoptions) [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/2.1.1/benchmark.js#L1162 "View in source") [Ⓣ][1] +

Benchmark.Suite.prototype.run([options={}])

+[Ⓢ](https://github.com/bestiejs/benchmark.js/blob/2.1.3/benchmark.js#L1162 "View in source") [Ⓣ][1] Runs the suite. @@ -427,8 +427,8 @@ suite.run({ 'async': true, 'queued': true }); -### `Benchmark.filter(array, callback)` -[#](#benchmarkfilterarray-callback) [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/2.1.1/benchmark.js#L763 "View in source") [Ⓣ][1] +

Benchmark.filter(array, callback)

+[Ⓢ](https://github.com/bestiejs/benchmark.js/blob/2.1.3/benchmark.js#L763 "View in source") [Ⓣ][1] A generic `Array#filter` like method. @@ -461,8 +461,8 @@ Benchmark.filter(benches, 'successful'); -### `Benchmark.formatNumber(number)` -[#](#benchmarkformatnumbernumber) [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/2.1.1/benchmark.js#L792 "View in source") [Ⓣ][1] +

Benchmark.formatNumber(number)

+[Ⓢ](https://github.com/bestiejs/benchmark.js/blob/2.1.3/benchmark.js#L792 "View in source") [Ⓣ][1] Converts a number to a more readable comma-separated string representation. @@ -478,8 +478,8 @@ Converts a number to a more readable comma-separated string representation. -### `Benchmark.invoke(benches, name, [args])` -[#](#benchmarkinvokebenches-name-args) [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/2.1.1/benchmark.js#L837 "View in source") [Ⓣ][1] +

Benchmark.invoke(benches, name, [args])

+[Ⓢ](https://github.com/bestiejs/benchmark.js/blob/2.1.3/benchmark.js#L837 "View in source") [Ⓣ][1] Invokes a method on all items in an array. @@ -527,8 +527,8 @@ Benchmark.invoke(benches, { -### `Benchmark.join(object, [separator1=','], [separator2=': '])` -[#](#benchmarkjoinobject-separator1-separator2:) [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/2.1.1/benchmark.js#L987 "View in source") [Ⓣ][1] +

Benchmark.join(object, [separator1=','], [separator2=': '])

+[Ⓢ](https://github.com/bestiejs/benchmark.js/blob/2.1.3/benchmark.js#L987 "View in source") [Ⓣ][1] Creates a string of joined array values or object key-value pairs. @@ -546,8 +546,8 @@ Creates a string of joined array values or object key-value pairs. -### `Benchmark.runInContext([context=root])` -[#](#benchmarkrunincontextcontextroot) [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/2.1.1/benchmark.js#L125 "View in source") [Ⓣ][1] +

Benchmark.runInContext([context=root])

+[Ⓢ](https://github.com/bestiejs/benchmark.js/blob/2.1.3/benchmark.js#L125 "View in source") [Ⓣ][1] Create a new `Benchmark` function using the given `context` object. @@ -563,8 +563,8 @@ Create a new `Benchmark` function using the given `context` object. -### `Benchmark.prototype.abort()` -[#](#benchmarkprototypeabort) [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/2.1.1/benchmark.js#L1328 "View in source") [Ⓣ][1] +

Benchmark.prototype.abort()

+[Ⓢ](https://github.com/bestiejs/benchmark.js/blob/2.1.3/benchmark.js#L1328 "View in source") [Ⓣ][1] Aborts the benchmark without recording times. @@ -577,8 +577,8 @@ Aborts the benchmark without recording times. -### `Benchmark.prototype.clone(options)` -[#](#benchmarkprototypecloneoptions) [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/2.1.1/benchmark.js#L1367 "View in source") [Ⓣ][1] +

Benchmark.prototype.clone(options)

+[Ⓢ](https://github.com/bestiejs/benchmark.js/blob/2.1.3/benchmark.js#L1367 "View in source") [Ⓣ][1] Creates a new benchmark using the same test and options. @@ -600,8 +600,8 @@ var bizarro = bench.clone({ -### `Benchmark.prototype.compare(other)` -[#](#benchmarkprototypecompareother) [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/2.1.1/benchmark.js#L1391 "View in source") [Ⓣ][1] +

Benchmark.prototype.compare(other)

+[Ⓢ](https://github.com/bestiejs/benchmark.js/blob/2.1.3/benchmark.js#L1391 "View in source") [Ⓣ][1] Determines if a benchmark is faster than another. @@ -617,8 +617,8 @@ Determines if a benchmark is faster than another. -### `Benchmark.prototype.emit(type, [args])` -[#](#benchmarkprototypeemittype-args) [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/2.1.1/benchmark.js#L1202 "View in source") [Ⓣ][1] +

Benchmark.prototype.emit(type, [args])

+[Ⓢ](https://github.com/bestiejs/benchmark.js/blob/2.1.3/benchmark.js#L1202 "View in source") [Ⓣ][1] Executes all registered listeners of the specified event type. @@ -635,8 +635,8 @@ Executes all registered listeners of the specified event type. -### `Benchmark.prototype.listeners(type)` -[#](#benchmarkprototypelistenerstype) [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/2.1.1/benchmark.js#L1232 "View in source") [Ⓣ][1] +

Benchmark.prototype.listeners(type)

+[Ⓢ](https://github.com/bestiejs/benchmark.js/blob/2.1.3/benchmark.js#L1232 "View in source") [Ⓣ][1] Returns an array of event listeners for a given type that can be manipulated to add or remove listeners. @@ -653,8 +653,8 @@ to add or remove listeners. -### `Benchmark.prototype.off([type], [listener])` -[#](#benchmarkprototypeofftype-listener) [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/2.1.1/benchmark.js#L1265 "View in source") [Ⓣ][1] +

Benchmark.prototype.off([type], [listener])

+[Ⓢ](https://github.com/bestiejs/benchmark.js/blob/2.1.3/benchmark.js#L1265 "View in source") [Ⓣ][1] Unregisters a listener for the specified event type(s), or unregisters all listeners for the specified event type(s), @@ -690,8 +690,8 @@ bench.off(); -### `Benchmark.prototype.on(type, listener)` -[#](#benchmarkprototypeontype-listener) [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/2.1.1/benchmark.js#L1307 "View in source") [Ⓣ][1] +

Benchmark.prototype.on(type, listener)

+[Ⓢ](https://github.com/bestiejs/benchmark.js/blob/2.1.3/benchmark.js#L1307 "View in source") [Ⓣ][1] Registers a listener for the specified event type(s). @@ -716,8 +716,8 @@ bench.on('start cycle', listener); -### `Benchmark.prototype.reset()` -[#](#benchmarkprototypereset) [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/2.1.1/benchmark.js#L1444 "View in source") [Ⓣ][1] +

Benchmark.prototype.reset()

+[Ⓢ](https://github.com/bestiejs/benchmark.js/blob/2.1.3/benchmark.js#L1444 "View in source") [Ⓣ][1] Reset properties and abort if running. @@ -730,8 +730,8 @@ Reset properties and abort if running. -### `Benchmark.prototype.run([options={}])` -[#](#benchmarkprototyperunoptions) [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/2.1.1/benchmark.js#L2080 "View in source") [Ⓣ][1] +

Benchmark.prototype.run([options={}])

+[Ⓢ](https://github.com/bestiejs/benchmark.js/blob/2.1.3/benchmark.js#L2093 "View in source") [Ⓣ][1] Runs the benchmark. @@ -755,8 +755,8 @@ bench.run({ 'async': true }); -### `Benchmark.prototype.toString()` -[#](#benchmarkprototypetostring) [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/2.1.1/benchmark.js#L1522 "View in source") [Ⓣ][1] +

Benchmark.prototype.toString()

+[Ⓢ](https://github.com/bestiejs/benchmark.js/blob/2.1.3/benchmark.js#L1525 "View in source") [Ⓣ][1] Displays relevant benchmark information when coerced to a string. @@ -775,8 +775,8 @@ Displays relevant benchmark information when coerced to a string. -### `Benchmark.Deferred.prototype.benchmark` -[#](#benchmarkdeferredprototypebenchmark) [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/2.1.1/benchmark.js#L2570 "View in source") [Ⓣ][1] +

Benchmark.Deferred.prototype.benchmark

+[Ⓢ](https://github.com/bestiejs/benchmark.js/blob/2.1.3/benchmark.js#L2583 "View in source") [Ⓣ][1] The deferred benchmark instance. @@ -786,8 +786,8 @@ The deferred benchmark instance. -### `Benchmark.Deferred.prototype.cycles` -[#](#benchmarkdeferredprototypecycles) [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/2.1.1/benchmark.js#L2578 "View in source") [Ⓣ][1] +

Benchmark.Deferred.prototype.cycles

+[Ⓢ](https://github.com/bestiejs/benchmark.js/blob/2.1.3/benchmark.js#L2591 "View in source") [Ⓣ][1] The number of deferred cycles performed while benchmarking. @@ -797,8 +797,8 @@ The number of deferred cycles performed while benchmarking. -### `Benchmark.Deferred.prototype.elapsed` -[#](#benchmarkdeferredprototypeelapsed) [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/2.1.1/benchmark.js#L2586 "View in source") [Ⓣ][1] +

Benchmark.Deferred.prototype.elapsed

+[Ⓢ](https://github.com/bestiejs/benchmark.js/blob/2.1.3/benchmark.js#L2599 "View in source") [Ⓣ][1] The time taken to complete the deferred benchmark *(secs)*. @@ -808,8 +808,8 @@ The time taken to complete the deferred benchmark *(secs)*. -### `Benchmark.Deferred.prototype.timeStamp` -[#](#benchmarkdeferredprototypetimestamp) [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/2.1.1/benchmark.js#L2594 "View in source") [Ⓣ][1] +

Benchmark.Deferred.prototype.timeStamp

+[Ⓢ](https://github.com/bestiejs/benchmark.js/blob/2.1.3/benchmark.js#L2607 "View in source") [Ⓣ][1] A timestamp of when the deferred benchmark started *(ms)*. @@ -819,8 +819,8 @@ A timestamp of when the deferred benchmark started *(ms)*. -### `Benchmark.Event.prototype.aborted` -[#](#benchmarkeventprototypeaborted) [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/2.1.1/benchmark.js#L2611 "View in source") [Ⓣ][1] +

Benchmark.Event.prototype.aborted

+[Ⓢ](https://github.com/bestiejs/benchmark.js/blob/2.1.3/benchmark.js#L2624 "View in source") [Ⓣ][1] A flag to indicate if the emitters listener iteration is aborted. @@ -830,8 +830,8 @@ A flag to indicate if the emitters listener iteration is aborted. -### `Benchmark.Event.prototype.cancelled` -[#](#benchmarkeventprototypecancelled) [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/2.1.1/benchmark.js#L2619 "View in source") [Ⓣ][1] +

Benchmark.Event.prototype.cancelled

+[Ⓢ](https://github.com/bestiejs/benchmark.js/blob/2.1.3/benchmark.js#L2632 "View in source") [Ⓣ][1] A flag to indicate if the default action is cancelled. @@ -841,8 +841,8 @@ A flag to indicate if the default action is cancelled. -### `Benchmark.Event.prototype.currentTarget` -[#](#benchmarkeventprototypecurrenttarget) [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/2.1.1/benchmark.js#L2627 "View in source") [Ⓣ][1] +

Benchmark.Event.prototype.currentTarget

+[Ⓢ](https://github.com/bestiejs/benchmark.js/blob/2.1.3/benchmark.js#L2640 "View in source") [Ⓣ][1] The object whose listeners are currently being processed. @@ -852,8 +852,8 @@ The object whose listeners are currently being processed. -### `Benchmark.Event.prototype.result` -[#](#benchmarkeventprototyperesult) [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/2.1.1/benchmark.js#L2635 "View in source") [Ⓣ][1] +

Benchmark.Event.prototype.result

+[Ⓢ](https://github.com/bestiejs/benchmark.js/blob/2.1.3/benchmark.js#L2648 "View in source") [Ⓣ][1] The return value of the last executed listener. @@ -863,8 +863,8 @@ The return value of the last executed listener. -### `Benchmark.Event.prototype.target` -[#](#benchmarkeventprototypetarget) [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/2.1.1/benchmark.js#L2643 "View in source") [Ⓣ][1] +

Benchmark.Event.prototype.target

+[Ⓢ](https://github.com/bestiejs/benchmark.js/blob/2.1.3/benchmark.js#L2656 "View in source") [Ⓣ][1] The object to which the event was originally emitted. @@ -874,8 +874,8 @@ The object to which the event was originally emitted. -### `Benchmark.Event.prototype.timeStamp` -[#](#benchmarkeventprototypetimestamp) [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/2.1.1/benchmark.js#L2651 "View in source") [Ⓣ][1] +

Benchmark.Event.prototype.timeStamp

+[Ⓢ](https://github.com/bestiejs/benchmark.js/blob/2.1.3/benchmark.js#L2664 "View in source") [Ⓣ][1] A timestamp of when the event was created *(ms)*. @@ -885,8 +885,8 @@ A timestamp of when the event was created *(ms)*. -### `Benchmark.Event.prototype.type` -[#](#benchmarkeventprototypetype) [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/2.1.1/benchmark.js#L2659 "View in source") [Ⓣ][1] +

Benchmark.Event.prototype.type

+[Ⓢ](https://github.com/bestiejs/benchmark.js/blob/2.1.3/benchmark.js#L2672 "View in source") [Ⓣ][1] The event type. @@ -896,8 +896,8 @@ The event type. -### `Benchmark.Suite.options` -[#](#benchmarksuiteoptions) [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/2.1.1/benchmark.js#L2671 "View in source") [Ⓣ][1] +

Benchmark.Suite.options

+[Ⓢ](https://github.com/bestiejs/benchmark.js/blob/2.1.3/benchmark.js#L2684 "View in source") [Ⓣ][1] The default options copied by suite instances. @@ -907,8 +907,8 @@ The default options copied by suite instances. -### `Benchmark.Suite.options.name` -[#](#benchmarksuiteoptionsname) [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/2.1.1/benchmark.js#L2679 "View in source") [Ⓣ][1] +

Benchmark.Suite.options.name

+[Ⓢ](https://github.com/bestiejs/benchmark.js/blob/2.1.3/benchmark.js#L2692 "View in source") [Ⓣ][1] The name of the suite. @@ -918,8 +918,8 @@ The name of the suite. -### `Benchmark.Suite.prototype.aborted` -[#](#benchmarksuiteprototypeaborted) [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/2.1.1/benchmark.js#L2700 "View in source") [Ⓣ][1] +

Benchmark.Suite.prototype.aborted

+[Ⓢ](https://github.com/bestiejs/benchmark.js/blob/2.1.3/benchmark.js#L2713 "View in source") [Ⓣ][1] A flag to indicate if the suite is aborted. @@ -929,8 +929,8 @@ A flag to indicate if the suite is aborted. -### `Benchmark.Suite.prototype.length` -[#](#benchmarksuiteprototypelength) [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/2.1.1/benchmark.js#L2692 "View in source") [Ⓣ][1] +

Benchmark.Suite.prototype.length

+[Ⓢ](https://github.com/bestiejs/benchmark.js/blob/2.1.3/benchmark.js#L2705 "View in source") [Ⓣ][1] The number of benchmarks in the suite. @@ -940,8 +940,8 @@ The number of benchmarks in the suite. -### `Benchmark.Suite.prototype.running` -[#](#benchmarksuiteprototyperunning) [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/2.1.1/benchmark.js#L2708 "View in source") [Ⓣ][1] +

Benchmark.Suite.prototype.running

+[Ⓢ](https://github.com/bestiejs/benchmark.js/blob/2.1.3/benchmark.js#L2721 "View in source") [Ⓣ][1] A flag to indicate if the suite is running. @@ -951,8 +951,8 @@ A flag to indicate if the suite is running. -### `Benchmark.options` -[#](#benchmarkoptions) [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/2.1.1/benchmark.js#L2129 "View in source") [Ⓣ][1] +

Benchmark.options

+[Ⓢ](https://github.com/bestiejs/benchmark.js/blob/2.1.3/benchmark.js#L2142 "View in source") [Ⓣ][1] The default options copied by benchmark instances. @@ -962,8 +962,8 @@ The default options copied by benchmark instances. -### `Benchmark.options.async` -[#](#benchmarkoptionsasync) [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/2.1.1/benchmark.js#L2138 "View in source") [Ⓣ][1] +

Benchmark.options.async

+[Ⓢ](https://github.com/bestiejs/benchmark.js/blob/2.1.3/benchmark.js#L2151 "View in source") [Ⓣ][1] A flag to indicate that benchmark cycles will execute asynchronously by default. @@ -974,8 +974,8 @@ by default. -### `Benchmark.options.defer` -[#](#benchmarkoptionsdefer) [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/2.1.1/benchmark.js#L2146 "View in source") [Ⓣ][1] +

Benchmark.options.defer

+[Ⓢ](https://github.com/bestiejs/benchmark.js/blob/2.1.3/benchmark.js#L2159 "View in source") [Ⓣ][1] A flag to indicate that the benchmark clock is deferred. @@ -985,8 +985,8 @@ A flag to indicate that the benchmark clock is deferred. -### `Benchmark.options.delay` -[#](#benchmarkoptionsdelay) [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/2.1.1/benchmark.js#L2153 "View in source") [Ⓣ][1] +

Benchmark.options.delay

+[Ⓢ](https://github.com/bestiejs/benchmark.js/blob/2.1.3/benchmark.js#L2166 "View in source") [Ⓣ][1] The delay between test cycles *(secs)*. @@ -996,8 +996,8 @@ The delay between test cycles *(secs)*. -### `Benchmark.options.id` -[#](#benchmarkoptionsid) [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/2.1.1/benchmark.js#L2162 "View in source") [Ⓣ][1] +

Benchmark.options.id

+[Ⓢ](https://github.com/bestiejs/benchmark.js/blob/2.1.3/benchmark.js#L2175 "View in source") [Ⓣ][1] Displayed by `Benchmark#toString` when a `name` is not available *(auto-generated if absent)*. @@ -1008,8 +1008,8 @@ Displayed by `Benchmark#toString` when a `name` is not available -### `Benchmark.options.initCount` -[#](#benchmarkoptionsinitcount) [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/2.1.1/benchmark.js#L2170 "View in source") [Ⓣ][1] +

Benchmark.options.initCount

+[Ⓢ](https://github.com/bestiejs/benchmark.js/blob/2.1.3/benchmark.js#L2183 "View in source") [Ⓣ][1] The default number of times to execute a test on a benchmark's first cycle. @@ -1019,8 +1019,8 @@ The default number of times to execute a test on a benchmark's first cycle. -### `Benchmark.options.maxTime` -[#](#benchmarkoptionsmaxtime) [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/2.1.1/benchmark.js#L2180 "View in source") [Ⓣ][1] +

Benchmark.options.maxTime

+[Ⓢ](https://github.com/bestiejs/benchmark.js/blob/2.1.3/benchmark.js#L2193 "View in source") [Ⓣ][1] The maximum time a benchmark is allowed to run before finishing *(secs)*.
@@ -1033,8 +1033,8 @@ Note: Cycle delays aren't counted toward the maximum time. -### `Benchmark.options.minSamples` -[#](#benchmarkoptionsminsamples) [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/2.1.1/benchmark.js#L2188 "View in source") [Ⓣ][1] +

Benchmark.options.minSamples

+[Ⓢ](https://github.com/bestiejs/benchmark.js/blob/2.1.3/benchmark.js#L2201 "View in source") [Ⓣ][1] The minimum sample size required to perform statistical analysis. @@ -1044,8 +1044,8 @@ The minimum sample size required to perform statistical analysis. -### `Benchmark.options.minTime` -[#](#benchmarkoptionsmintime) [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/2.1.1/benchmark.js#L2196 "View in source") [Ⓣ][1] +

Benchmark.options.minTime

+[Ⓢ](https://github.com/bestiejs/benchmark.js/blob/2.1.3/benchmark.js#L2209 "View in source") [Ⓣ][1] The time needed to reduce the percent uncertainty of measurement to `1`% *(secs)*. @@ -1055,8 +1055,8 @@ The time needed to reduce the percent uncertainty of measurement to `1`% *(secs) -### `Benchmark.options.name` -[#](#benchmarkoptionsname) [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/2.1.1/benchmark.js#L2204 "View in source") [Ⓣ][1] +

Benchmark.options.name

+[Ⓢ](https://github.com/bestiejs/benchmark.js/blob/2.1.3/benchmark.js#L2217 "View in source") [Ⓣ][1] The name of the benchmark. @@ -1066,8 +1066,8 @@ The name of the benchmark. -### `Benchmark.options.onAbort` -[#](#benchmarkoptionsonabort) [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/2.1.1/benchmark.js#L2212 "View in source") [Ⓣ][1] +

Benchmark.options.onAbort

+[Ⓢ](https://github.com/bestiejs/benchmark.js/blob/2.1.3/benchmark.js#L2225 "View in source") [Ⓣ][1] An event listener called when the benchmark is aborted. @@ -1077,8 +1077,8 @@ An event listener called when the benchmark is aborted. -### `Benchmark.options.onComplete` -[#](#benchmarkoptionsoncomplete) [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/2.1.1/benchmark.js#L2220 "View in source") [Ⓣ][1] +

Benchmark.options.onComplete

+[Ⓢ](https://github.com/bestiejs/benchmark.js/blob/2.1.3/benchmark.js#L2233 "View in source") [Ⓣ][1] An event listener called when the benchmark completes running. @@ -1088,8 +1088,8 @@ An event listener called when the benchmark completes running. -### `Benchmark.options.onCycle` -[#](#benchmarkoptionsoncycle) [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/2.1.1/benchmark.js#L2228 "View in source") [Ⓣ][1] +

Benchmark.options.onCycle

+[Ⓢ](https://github.com/bestiejs/benchmark.js/blob/2.1.3/benchmark.js#L2241 "View in source") [Ⓣ][1] An event listener called after each run cycle. @@ -1099,8 +1099,8 @@ An event listener called after each run cycle. -### `Benchmark.options.onError` -[#](#benchmarkoptionsonerror) [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/2.1.1/benchmark.js#L2236 "View in source") [Ⓣ][1] +

Benchmark.options.onError

+[Ⓢ](https://github.com/bestiejs/benchmark.js/blob/2.1.3/benchmark.js#L2249 "View in source") [Ⓣ][1] An event listener called when a test errors. @@ -1110,8 +1110,8 @@ An event listener called when a test errors. -### `Benchmark.options.onReset` -[#](#benchmarkoptionsonreset) [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/2.1.1/benchmark.js#L2244 "View in source") [Ⓣ][1] +

Benchmark.options.onReset

+[Ⓢ](https://github.com/bestiejs/benchmark.js/blob/2.1.3/benchmark.js#L2257 "View in source") [Ⓣ][1] An event listener called when the benchmark is reset. @@ -1121,8 +1121,8 @@ An event listener called when the benchmark is reset. -### `Benchmark.options.onStart` -[#](#benchmarkoptionsonstart) [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/2.1.1/benchmark.js#L2252 "View in source") [Ⓣ][1] +

Benchmark.options.onStart

+[Ⓢ](https://github.com/bestiejs/benchmark.js/blob/2.1.3/benchmark.js#L2265 "View in source") [Ⓣ][1] An event listener called when the benchmark starts running. @@ -1132,8 +1132,8 @@ An event listener called when the benchmark starts running. -### `Benchmark.platform` -[#](#benchmarkplatform) [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/2.1.1/benchmark.js#L2263 "View in source") [Ⓣ][1] +

Benchmark.platform

+[Ⓢ](https://github.com/bestiejs/benchmark.js/blob/2.1.3/benchmark.js#L2276 "View in source") [Ⓣ][1] Platform object with properties describing things like browser name, version, and operating system. See [`platform.js`](https://mths.be/platform). @@ -1144,8 +1144,8 @@ version, and operating system. See [`platform.js`](https://mths.be/platform). -### `Benchmark.support` -[#](#benchmarksupport) [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/2.1.1/benchmark.js#L195 "View in source") [Ⓣ][1] +

Benchmark.support

+[Ⓢ](https://github.com/bestiejs/benchmark.js/blob/2.1.3/benchmark.js#L195 "View in source") [Ⓣ][1] An object used to flag environments/features. @@ -1155,8 +1155,8 @@ An object used to flag environments/features. -### `Benchmark.support.browser` -[#](#benchmarksupportbrowser) [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/2.1.1/benchmark.js#L205 "View in source") [Ⓣ][1] +

Benchmark.support.browser

+[Ⓢ](https://github.com/bestiejs/benchmark.js/blob/2.1.3/benchmark.js#L205 "View in source") [Ⓣ][1] Detect if running in a browser environment. @@ -1166,8 +1166,8 @@ Detect if running in a browser environment. -### `Benchmark.version` -[#](#benchmarkversion) [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/2.1.1/benchmark.js#L2284 "View in source") [Ⓣ][1] +

Benchmark.version

+[Ⓢ](https://github.com/bestiejs/benchmark.js/blob/2.1.3/benchmark.js#L2297 "View in source") [Ⓣ][1] The semantic version number. @@ -1177,8 +1177,8 @@ The semantic version number. -### `Benchmark.prototype.aborted` -[#](#benchmarkprototypeaborted) [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/2.1.1/benchmark.js#L2359 "View in source") [Ⓣ][1] +

Benchmark.prototype.aborted

+[Ⓢ](https://github.com/bestiejs/benchmark.js/blob/2.1.3/benchmark.js#L2372 "View in source") [Ⓣ][1] A flag to indicate if the benchmark is aborted. @@ -1188,8 +1188,8 @@ A flag to indicate if the benchmark is aborted. -### `Benchmark.prototype.compiled` -[#](#benchmarkprototypecompiled) [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/2.1.1/benchmark.js#L2335 "View in source") [Ⓣ][1] +

Benchmark.prototype.compiled

+[Ⓢ](https://github.com/bestiejs/benchmark.js/blob/2.1.3/benchmark.js#L2348 "View in source") [Ⓣ][1] The compiled test function. @@ -1199,8 +1199,8 @@ The compiled test function. -### `Benchmark.prototype.count` -[#](#benchmarkprototypecount) [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/2.1.1/benchmark.js#L2311 "View in source") [Ⓣ][1] +

Benchmark.prototype.count

+[Ⓢ](https://github.com/bestiejs/benchmark.js/blob/2.1.3/benchmark.js#L2324 "View in source") [Ⓣ][1] The number of times a test was executed. @@ -1210,8 +1210,8 @@ The number of times a test was executed. -### `Benchmark.prototype.cycles` -[#](#benchmarkprototypecycles) [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/2.1.1/benchmark.js#L2319 "View in source") [Ⓣ][1] +

Benchmark.prototype.cycles

+[Ⓢ](https://github.com/bestiejs/benchmark.js/blob/2.1.3/benchmark.js#L2332 "View in source") [Ⓣ][1] The number of cycles performed while benchmarking. @@ -1221,8 +1221,8 @@ The number of cycles performed while benchmarking. -### `Benchmark.support.decompilation` -[#](#benchmarksupportdecompilation) [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/2.1.1/benchmark.js#L222 "View in source") [Ⓣ][1] +

Benchmark.support.decompilation

+[Ⓢ](https://github.com/bestiejs/benchmark.js/blob/2.1.3/benchmark.js#L222 "View in source") [Ⓣ][1] Detect if function decompilation is support. @@ -1232,8 +1232,8 @@ Detect if function decompilation is support. -### `Benchmark.prototype.error` -[#](#benchmarkprototypeerror) [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/2.1.1/benchmark.js#L2343 "View in source") [Ⓣ][1] +

Benchmark.prototype.error

+[Ⓢ](https://github.com/bestiejs/benchmark.js/blob/2.1.3/benchmark.js#L2356 "View in source") [Ⓣ][1] The error object if the test failed. @@ -1243,8 +1243,8 @@ The error object if the test failed. -### `Benchmark.prototype.fn` -[#](#benchmarkprototypefn) [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/2.1.1/benchmark.js#L2351 "View in source") [Ⓣ][1] +

Benchmark.prototype.fn

+[Ⓢ](https://github.com/bestiejs/benchmark.js/blob/2.1.3/benchmark.js#L2364 "View in source") [Ⓣ][1] The test to benchmark. @@ -1254,8 +1254,8 @@ The test to benchmark. -### `Benchmark.prototype.hz` -[#](#benchmarkprototypehz) [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/2.1.1/benchmark.js#L2327 "View in source") [Ⓣ][1] +

Benchmark.prototype.hz

+[Ⓢ](https://github.com/bestiejs/benchmark.js/blob/2.1.3/benchmark.js#L2340 "View in source") [Ⓣ][1] The number of executions per second. @@ -1265,8 +1265,8 @@ The number of executions per second. -### `Benchmark.prototype.running` -[#](#benchmarkprototyperunning) [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/2.1.1/benchmark.js#L2367 "View in source") [Ⓣ][1] +

Benchmark.prototype.running

+[Ⓢ](https://github.com/bestiejs/benchmark.js/blob/2.1.3/benchmark.js#L2380 "View in source") [Ⓣ][1] A flag to indicate if the benchmark is running. @@ -1276,8 +1276,8 @@ A flag to indicate if the benchmark is running. -### `Benchmark.prototype.setup` -[#](#benchmarkprototypesetup) [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/2.1.1/benchmark.js#L2430 "View in source") [Ⓣ][1] +

Benchmark.prototype.setup

+[Ⓢ](https://github.com/bestiejs/benchmark.js/blob/2.1.3/benchmark.js#L2443 "View in source") [Ⓣ][1] Compiled into the test and executed immediately **before** the test loop. @@ -1343,8 +1343,8 @@ var a = 0; -### `Benchmark.prototype.stats` -[#](#benchmarkprototypestats) [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/2.1.1/benchmark.js#L2446 "View in source") [Ⓣ][1] +

Benchmark.prototype.stats

+[Ⓢ](https://github.com/bestiejs/benchmark.js/blob/2.1.3/benchmark.js#L2459 "View in source") [Ⓣ][1] An object of stats including mean, margin or error, and standard deviation. @@ -1354,8 +1354,8 @@ An object of stats including mean, margin or error, and standard deviation. -### `Benchmark.prototype.teardown` -[#](#benchmarkprototypeteardown) [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/2.1.1/benchmark.js#L2438 "View in source") [Ⓣ][1] +

Benchmark.prototype.teardown

+[Ⓢ](https://github.com/bestiejs/benchmark.js/blob/2.1.3/benchmark.js#L2451 "View in source") [Ⓣ][1] Compiled into the test and executed immediately **after** the test loop. @@ -1365,8 +1365,8 @@ Compiled into the test and executed immediately **after** the test loop. -### `Benchmark.support.timeout` -[#](#benchmarksupporttimeout) [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/2.1.1/benchmark.js#L213 "View in source") [Ⓣ][1] +

Benchmark.support.timeout

+[Ⓢ](https://github.com/bestiejs/benchmark.js/blob/2.1.3/benchmark.js#L213 "View in source") [Ⓣ][1] Detect if the Timers API exists. @@ -1376,8 +1376,8 @@ Detect if the Timers API exists. -### `Benchmark.prototype.times` -[#](#benchmarkprototypetimes) [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/2.1.1/benchmark.js#L2511 "View in source") [Ⓣ][1] +

Benchmark.prototype.times

+[Ⓢ](https://github.com/bestiejs/benchmark.js/blob/2.1.3/benchmark.js#L2524 "View in source") [Ⓣ][1] An object of timing data including cycle, elapsed, period, start, and stop. @@ -1387,8 +1387,8 @@ An object of timing data including cycle, elapsed, period, start, and stop. -### `Benchmark#stats.deviation` -[#](#benchmark-statsdeviation) [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/2.1.1/benchmark.js#L2478 "View in source") [Ⓣ][1] +

Benchmark#stats.deviation

+[Ⓢ](https://github.com/bestiejs/benchmark.js/blob/2.1.3/benchmark.js#L2491 "View in source") [Ⓣ][1] The sample standard deviation. @@ -1398,8 +1398,8 @@ The sample standard deviation. -### `Benchmark#stats.mean` -[#](#benchmark-statsmean) [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/2.1.1/benchmark.js#L2486 "View in source") [Ⓣ][1] +

Benchmark#stats.mean

+[Ⓢ](https://github.com/bestiejs/benchmark.js/blob/2.1.3/benchmark.js#L2499 "View in source") [Ⓣ][1] The sample arithmetic mean *(secs)*. @@ -1409,8 +1409,8 @@ The sample arithmetic mean *(secs)*. -### `Benchmark#stats.moe` -[#](#benchmark-statsmoe) [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/2.1.1/benchmark.js#L2454 "View in source") [Ⓣ][1] +

Benchmark#stats.moe

+[Ⓢ](https://github.com/bestiejs/benchmark.js/blob/2.1.3/benchmark.js#L2467 "View in source") [Ⓣ][1] The margin of error. @@ -1420,8 +1420,8 @@ The margin of error. -### `Benchmark#stats.rme` -[#](#benchmark-statsrme) [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/2.1.1/benchmark.js#L2462 "View in source") [Ⓣ][1] +

Benchmark#stats.rme

+[Ⓢ](https://github.com/bestiejs/benchmark.js/blob/2.1.3/benchmark.js#L2475 "View in source") [Ⓣ][1] The relative margin of error *(expressed as a percentage of the mean)*. @@ -1431,8 +1431,8 @@ The relative margin of error *(expressed as a percentage of the mean)*. -### `Benchmark#stats.sample` -[#](#benchmark-statssample) [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/2.1.1/benchmark.js#L2494 "View in source") [Ⓣ][1] +

Benchmark#stats.sample

+[Ⓢ](https://github.com/bestiejs/benchmark.js/blob/2.1.3/benchmark.js#L2507 "View in source") [Ⓣ][1] The array of sampled periods. @@ -1442,8 +1442,8 @@ The array of sampled periods. -### `Benchmark#stats.sem` -[#](#benchmark-statssem) [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/2.1.1/benchmark.js#L2470 "View in source") [Ⓣ][1] +

Benchmark#stats.sem

+[Ⓢ](https://github.com/bestiejs/benchmark.js/blob/2.1.3/benchmark.js#L2483 "View in source") [Ⓣ][1] The standard error of the mean. @@ -1453,8 +1453,8 @@ The standard error of the mean. -### `Benchmark#stats.variance` -[#](#benchmark-statsvariance) [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/2.1.1/benchmark.js#L2502 "View in source") [Ⓣ][1] +

Benchmark#stats.variance

+[Ⓢ](https://github.com/bestiejs/benchmark.js/blob/2.1.3/benchmark.js#L2515 "View in source") [Ⓣ][1] The sample variance. @@ -1464,8 +1464,8 @@ The sample variance. -### `Benchmark#times.cycle` -[#](#benchmark-timescycle) [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/2.1.1/benchmark.js#L2519 "View in source") [Ⓣ][1] +

Benchmark#times.cycle

+[Ⓢ](https://github.com/bestiejs/benchmark.js/blob/2.1.3/benchmark.js#L2532 "View in source") [Ⓣ][1] The time taken to complete the last cycle *(secs)*. @@ -1475,8 +1475,8 @@ The time taken to complete the last cycle *(secs)*. -### `Benchmark#times.elapsed` -[#](#benchmark-timeselapsed) [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/2.1.1/benchmark.js#L2527 "View in source") [Ⓣ][1] +

Benchmark#times.elapsed

+[Ⓢ](https://github.com/bestiejs/benchmark.js/blob/2.1.3/benchmark.js#L2540 "View in source") [Ⓣ][1] The time taken to complete the benchmark *(secs)*. @@ -1486,8 +1486,8 @@ The time taken to complete the benchmark *(secs)*. -### `Benchmark#times.period` -[#](#benchmark-timesperiod) [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/2.1.1/benchmark.js#L2535 "View in source") [Ⓣ][1] +

Benchmark#times.period

+[Ⓢ](https://github.com/bestiejs/benchmark.js/blob/2.1.3/benchmark.js#L2548 "View in source") [Ⓣ][1] The time taken to execute the test once *(secs)*. @@ -1497,8 +1497,8 @@ The time taken to execute the test once *(secs)*. -### `Benchmark#times.timeStamp` -[#](#benchmark-timestimestamp) [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/2.1.1/benchmark.js#L2543 "View in source") [Ⓣ][1] +

Benchmark#times.timeStamp

+[Ⓢ](https://github.com/bestiejs/benchmark.js/blob/2.1.3/benchmark.js#L2556 "View in source") [Ⓣ][1] A timestamp of when the benchmark started *(ms)*. diff --git a/package.json b/package.json index 4227f844..c831e485 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "benchmark", - "version": "2.1.2", + "version": "2.1.3", "description": "A benchmarking library that supports high-resolution timers & returns statistically significant results.", "homepage": "https://benchmarkjs.com/", "license": "MIT",