From f6da8b58bcc69a1a9be8810b93ce0df41d3bea78 Mon Sep 17 00:00:00 2001 From: John-David Dalton Date: Thu, 16 Aug 2012 23:51:46 -0700 Subject: [PATCH] Remove `noArgumentsClass` check from `isPlainObject` and minor repo housekeeping. --- benchmark.js | 3 +- doc/README.md | 142 +++++++++++++++++++-------------------- vendor/docdown/README.md | 13 +--- 3 files changed, 74 insertions(+), 84 deletions(-) diff --git a/benchmark.js b/benchmark.js index d8eb3094..db2c9958 100644 --- a/benchmark.js +++ b/benchmark.js @@ -1044,7 +1044,7 @@ function isPlainObject(value) { // avoid non-objects and false positives for `arguments` objects in IE < 9 var result = false; - if (!(value && typeof value == 'object') || (noArgumentsClass && isArguments(value))) { + if (!(value && typeof value == 'object') || isArguments(value)) { return result; } // IE < 9 presents DOM nodes as `Object` objects except they have `toString` @@ -3091,6 +3091,7 @@ /** * The maximum time a benchmark is allowed to run before finishing (secs). + * * Note: Cycle delays aren't counted toward the maximum time. * * @memberOf Benchmark.options diff --git a/doc/README.md b/doc/README.md index 5b8960a5..9b59c02c 100644 --- a/doc/README.md +++ b/doc/README.md @@ -354,7 +354,7 @@ var bench = new Benchmark('foo', function() { ### `Benchmark.version` -# [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/master/benchmark.js#L3267 "View in source") [Ⓣ][1] +# [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/master/benchmark.js#L3268 "View in source") [Ⓣ][1] *(String)*: The semantic version number. @@ -713,7 +713,7 @@ A generic `Array#reduce` like method. ### `Benchmark.prototype.aborted` -# [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/master/benchmark.js#L3377 "View in source") [Ⓣ][1] +# [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/master/benchmark.js#L3378 "View in source") [Ⓣ][1] *(Boolean)*: A flag to indicate if the benchmark is aborted. @@ -725,7 +725,7 @@ A generic `Array#reduce` like method. ### `Benchmark.prototype.compiled` -# [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/master/benchmark.js#L3353 "View in source") [Ⓣ][1] +# [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/master/benchmark.js#L3354 "View in source") [Ⓣ][1] *(Function, String)*: The compiled test function. @@ -737,7 +737,7 @@ A generic `Array#reduce` like method. ### `Benchmark.prototype.count` -# [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/master/benchmark.js#L3329 "View in source") [Ⓣ][1] +# [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/master/benchmark.js#L3330 "View in source") [Ⓣ][1] *(Number)*: The number of times a test was executed. @@ -749,7 +749,7 @@ A generic `Array#reduce` like method. ### `Benchmark.prototype.cycles` -# [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/master/benchmark.js#L3337 "View in source") [Ⓣ][1] +# [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/master/benchmark.js#L3338 "View in source") [Ⓣ][1] *(Number)*: The number of cycles performed while benchmarking. @@ -761,7 +761,7 @@ A generic `Array#reduce` like method. ### `Benchmark.prototype.fn` -# [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/master/benchmark.js#L3369 "View in source") [Ⓣ][1] +# [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/master/benchmark.js#L3370 "View in source") [Ⓣ][1] *(Function, String)*: The test to benchmark. @@ -773,7 +773,7 @@ A generic `Array#reduce` like method. ### `Benchmark.prototype.hz` -# [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/master/benchmark.js#L3345 "View in source") [Ⓣ][1] +# [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/master/benchmark.js#L3346 "View in source") [Ⓣ][1] *(Number)*: The number of executions per second. @@ -785,7 +785,7 @@ A generic `Array#reduce` like method. ### `Benchmark.prototype.running` -# [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/master/benchmark.js#L3385 "View in source") [Ⓣ][1] +# [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/master/benchmark.js#L3386 "View in source") [Ⓣ][1] *(Boolean)*: A flag to indicate if the benchmark is running. @@ -797,7 +797,7 @@ A generic `Array#reduce` like method. ### `Benchmark.prototype.setup` -# [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/master/benchmark.js#L3448 "View in source") [Ⓣ][1] +# [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/master/benchmark.js#L3449 "View in source") [Ⓣ][1] *(Function, String)*: Compiled into the test and executed immediately **before** the test loop. @@ -866,7 +866,7 @@ var a = 0; ### `Benchmark.prototype.teardown` -# [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/master/benchmark.js#L3456 "View in source") [Ⓣ][1] +# [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/master/benchmark.js#L3457 "View in source") [Ⓣ][1] *(Function, String)*: Compiled into the test and executed immediately **after** the test loop. @@ -1173,9 +1173,9 @@ Displays relevant benchmark information when coerced to a string. ### `Benchmark.options.maxTime` -# [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/master/benchmark.js#L3099 "View in source") [Ⓣ][1] +# [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/master/benchmark.js#L3100 "View in source") [Ⓣ][1] -*(Number)*: The maximum time a benchmark is allowed to run before finishing *(secs)*. Note: Cycle delays aren't counted toward the maximum time. +*(Number)*: The maximum time a benchmark is allowed to run before finishing *(secs)*. Note: Cycle delays aren't counted toward the maximum time. * * * @@ -1185,7 +1185,7 @@ Displays relevant benchmark information when coerced to a string. ### `Benchmark.options.minSamples` -# [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/master/benchmark.js#L3107 "View in source") [Ⓣ][1] +# [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/master/benchmark.js#L3108 "View in source") [Ⓣ][1] *(Number)*: The minimum sample size required to perform statistical analysis. @@ -1197,7 +1197,7 @@ Displays relevant benchmark information when coerced to a string. ### `Benchmark.options.minTime` -# [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/master/benchmark.js#L3115 "View in source") [Ⓣ][1] +# [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/master/benchmark.js#L3116 "View in source") [Ⓣ][1] *(Number)*: The time needed to reduce the percent uncertainty of measurement to `1`% *(secs)*. @@ -1209,7 +1209,7 @@ Displays relevant benchmark information when coerced to a string. ### `Benchmark.options.name` -# [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/master/benchmark.js#L3123 "View in source") [Ⓣ][1] +# [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/master/benchmark.js#L3124 "View in source") [Ⓣ][1] *(String)*: The name of the benchmark. @@ -1221,7 +1221,7 @@ Displays relevant benchmark information when coerced to a string. ### `Benchmark.options.onAbort` -# [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/master/benchmark.js#L3131 "View in source") [Ⓣ][1] +# [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/master/benchmark.js#L3132 "View in source") [Ⓣ][1] An event listener called when the benchmark is aborted. @@ -1233,7 +1233,7 @@ An event listener called when the benchmark is aborted. ### `Benchmark.options.onComplete` -# [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/master/benchmark.js#L3139 "View in source") [Ⓣ][1] +# [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/master/benchmark.js#L3140 "View in source") [Ⓣ][1] An event listener called when the benchmark completes running. @@ -1245,7 +1245,7 @@ An event listener called when the benchmark completes running. ### `Benchmark.options.onCycle` -# [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/master/benchmark.js#L3147 "View in source") [Ⓣ][1] +# [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/master/benchmark.js#L3148 "View in source") [Ⓣ][1] An event listener called after each run cycle. @@ -1257,7 +1257,7 @@ An event listener called after each run cycle. ### `Benchmark.options.onError` -# [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/master/benchmark.js#L3155 "View in source") [Ⓣ][1] +# [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/master/benchmark.js#L3156 "View in source") [Ⓣ][1] An event listener called when a test errors. @@ -1269,7 +1269,7 @@ An event listener called when a test errors. ### `Benchmark.options.onReset` -# [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/master/benchmark.js#L3163 "View in source") [Ⓣ][1] +# [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/master/benchmark.js#L3164 "View in source") [Ⓣ][1] An event listener called when the benchmark is reset. @@ -1281,7 +1281,7 @@ An event listener called when the benchmark is reset. ### `Benchmark.options.onStart` -# [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/master/benchmark.js#L3171 "View in source") [Ⓣ][1] +# [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/master/benchmark.js#L3172 "View in source") [Ⓣ][1] An event listener called when the benchmark starts running. @@ -1300,7 +1300,7 @@ An event listener called when the benchmark starts running. ### `Benchmark.platform` -# [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/master/benchmark.js#L3182 "View in source") [Ⓣ][1] +# [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/master/benchmark.js#L3183 "View in source") [Ⓣ][1] *(Object)*: Platform object with properties describing things like browser name, version, and operating system. @@ -1312,7 +1312,7 @@ An event listener called when the benchmark starts running. ### `Benchmark.platform.description` -# [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/master/benchmark.js#L3190 "View in source") [Ⓣ][1] +# [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/master/benchmark.js#L3191 "View in source") [Ⓣ][1] *(String)*: The platform description. @@ -1324,7 +1324,7 @@ An event listener called when the benchmark starts running. ### `Benchmark.platform.layout` -# [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/master/benchmark.js#L3198 "View in source") [Ⓣ][1] +# [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/master/benchmark.js#L3199 "View in source") [Ⓣ][1] *(String, Null)*: The name of the browser layout engine. @@ -1336,7 +1336,7 @@ An event listener called when the benchmark starts running. ### `Benchmark.platform.manufacturer` -# [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/master/benchmark.js#L3222 "View in source") [Ⓣ][1] +# [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/master/benchmark.js#L3223 "View in source") [Ⓣ][1] *(String, Null)*: The name of the product's manufacturer. @@ -1348,7 +1348,7 @@ An event listener called when the benchmark starts running. ### `Benchmark.platform.name` -# [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/master/benchmark.js#L3214 "View in source") [Ⓣ][1] +# [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/master/benchmark.js#L3215 "View in source") [Ⓣ][1] *(String, Null)*: The name of the browser/environment. @@ -1360,7 +1360,7 @@ An event listener called when the benchmark starts running. ### `Benchmark.platform.os` -# [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/master/benchmark.js#L3230 "View in source") [Ⓣ][1] +# [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/master/benchmark.js#L3231 "View in source") [Ⓣ][1] *(String, Null)*: The name of the operating system. @@ -1372,7 +1372,7 @@ An event listener called when the benchmark starts running. ### `Benchmark.platform.prerelease` -# [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/master/benchmark.js#L3238 "View in source") [Ⓣ][1] +# [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/master/benchmark.js#L3239 "View in source") [Ⓣ][1] *(String, Null)*: The alpha/beta release indicator. @@ -1384,7 +1384,7 @@ An event listener called when the benchmark starts running. ### `Benchmark.platform.product` -# [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/master/benchmark.js#L3206 "View in source") [Ⓣ][1] +# [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/master/benchmark.js#L3207 "View in source") [Ⓣ][1] *(String, Null)*: The name of the product hosting the browser. @@ -1396,7 +1396,7 @@ An event listener called when the benchmark starts running. ### `Benchmark.platform.version` -# [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/master/benchmark.js#L3246 "View in source") [Ⓣ][1] +# [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/master/benchmark.js#L3247 "View in source") [Ⓣ][1] *(String, Null)*: The browser/environment version. @@ -1408,7 +1408,7 @@ An event listener called when the benchmark starts running. ### `Benchmark.platform.toString()` -# [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/master/benchmark.js#L3255 "View in source") [Ⓣ][1] +# [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/master/benchmark.js#L3256 "View in source") [Ⓣ][1] Return platform description when the platform object is coerced to a string. @@ -1593,7 +1593,7 @@ Return platform description when the platform object is coerced to a string. ### `Benchmark.prototype.error` -# [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/master/benchmark.js#L3361 "View in source") [Ⓣ][1] +# [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/master/benchmark.js#L3362 "View in source") [Ⓣ][1] *(Object)*: The error object if the test failed. @@ -1612,7 +1612,7 @@ Return platform description when the platform object is coerced to a string. ### `Benchmark.prototype.stats` -# [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/master/benchmark.js#L3464 "View in source") [Ⓣ][1] +# [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/master/benchmark.js#L3465 "View in source") [Ⓣ][1] *(Object)*: An object of stats including mean, margin or error, and standard deviation. @@ -1624,7 +1624,7 @@ Return platform description when the platform object is coerced to a string. ### `Benchmark.prototype.stats.deviation` -# [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/master/benchmark.js#L3496 "View in source") [Ⓣ][1] +# [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/master/benchmark.js#L3497 "View in source") [Ⓣ][1] *(Number)*: The sample standard deviation. @@ -1636,7 +1636,7 @@ Return platform description when the platform object is coerced to a string. ### `Benchmark.prototype.stats.mean` -# [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/master/benchmark.js#L3504 "View in source") [Ⓣ][1] +# [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/master/benchmark.js#L3505 "View in source") [Ⓣ][1] *(Number)*: The sample arithmetic mean. @@ -1648,7 +1648,7 @@ Return platform description when the platform object is coerced to a string. ### `Benchmark.prototype.stats.moe` -# [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/master/benchmark.js#L3472 "View in source") [Ⓣ][1] +# [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/master/benchmark.js#L3473 "View in source") [Ⓣ][1] *(Number)*: The margin of error. @@ -1660,7 +1660,7 @@ Return platform description when the platform object is coerced to a string. ### `Benchmark.prototype.stats.rme` -# [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/master/benchmark.js#L3480 "View in source") [Ⓣ][1] +# [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/master/benchmark.js#L3481 "View in source") [Ⓣ][1] *(Number)*: The relative margin of error *(expressed as a percentage of the mean)*. @@ -1672,7 +1672,7 @@ Return platform description when the platform object is coerced to a string. ### `Benchmark.prototype.stats.sample` -# [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/master/benchmark.js#L3512 "View in source") [Ⓣ][1] +# [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/master/benchmark.js#L3513 "View in source") [Ⓣ][1] *(Array)*: The array of sampled periods. @@ -1684,7 +1684,7 @@ Return platform description when the platform object is coerced to a string. ### `Benchmark.prototype.stats.sem` -# [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/master/benchmark.js#L3488 "View in source") [Ⓣ][1] +# [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/master/benchmark.js#L3489 "View in source") [Ⓣ][1] *(Number)*: The standard error of the mean. @@ -1696,7 +1696,7 @@ Return platform description when the platform object is coerced to a string. ### `Benchmark.prototype.stats.variance` -# [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/master/benchmark.js#L3520 "View in source") [Ⓣ][1] +# [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/master/benchmark.js#L3521 "View in source") [Ⓣ][1] *(Number)*: The sample variance. @@ -1715,7 +1715,7 @@ Return platform description when the platform object is coerced to a string. ### `Benchmark.prototype.times` -# [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/master/benchmark.js#L3529 "View in source") [Ⓣ][1] +# [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/master/benchmark.js#L3530 "View in source") [Ⓣ][1] *(Object)*: An object of timing data including cycle, elapsed, period, start, and stop. @@ -1727,7 +1727,7 @@ Return platform description when the platform object is coerced to a string. ### `Benchmark.prototype.times.cycle` -# [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/master/benchmark.js#L3537 "View in source") [Ⓣ][1] +# [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/master/benchmark.js#L3538 "View in source") [Ⓣ][1] *(Number)*: The time taken to complete the last cycle *(secs)*. @@ -1739,7 +1739,7 @@ Return platform description when the platform object is coerced to a string. ### `Benchmark.prototype.times.elapsed` -# [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/master/benchmark.js#L3545 "View in source") [Ⓣ][1] +# [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/master/benchmark.js#L3546 "View in source") [Ⓣ][1] *(Number)*: The time taken to complete the benchmark *(secs)*. @@ -1751,7 +1751,7 @@ Return platform description when the platform object is coerced to a string. ### `Benchmark.prototype.times.period` -# [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/master/benchmark.js#L3553 "View in source") [Ⓣ][1] +# [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/master/benchmark.js#L3554 "View in source") [Ⓣ][1] *(Number)*: The time taken to execute the test once *(secs)*. @@ -1763,7 +1763,7 @@ Return platform description when the platform object is coerced to a string. ### `Benchmark.prototype.times.timeStamp` -# [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/master/benchmark.js#L3561 "View in source") [Ⓣ][1] +# [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/master/benchmark.js#L3562 "View in source") [Ⓣ][1] *(Number)*: A timestamp of when the benchmark started *(ms)*. @@ -1804,7 +1804,7 @@ The Deferred constructor. ### `Benchmark.Deferred.prototype.benchmark` -# [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/master/benchmark.js#L3605 "View in source") [Ⓣ][1] +# [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/master/benchmark.js#L3606 "View in source") [Ⓣ][1] *(Object)*: The deferred benchmark instance. @@ -1816,7 +1816,7 @@ The Deferred constructor. ### `Benchmark.Deferred.prototype.cycles` -# [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/master/benchmark.js#L3613 "View in source") [Ⓣ][1] +# [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/master/benchmark.js#L3614 "View in source") [Ⓣ][1] *(Number)*: The number of deferred cycles performed while benchmarking. @@ -1828,7 +1828,7 @@ The Deferred constructor. ### `Benchmark.Deferred.prototype.elapsed` -# [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/master/benchmark.js#L3621 "View in source") [Ⓣ][1] +# [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/master/benchmark.js#L3622 "View in source") [Ⓣ][1] *(Number)*: The time taken to complete the deferred benchmark *(secs)*. @@ -1852,7 +1852,7 @@ The Deferred constructor. ### `Benchmark.Deferred.prototype.timeStamp` -# [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/master/benchmark.js#L3629 "View in source") [Ⓣ][1] +# [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/master/benchmark.js#L3630 "View in source") [Ⓣ][1] *(Number)*: A timestamp of when the deferred benchmark started *(ms)*. @@ -1893,7 +1893,7 @@ The Event constructor. ### `Benchmark.Event.prototype.aborted` -# [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/master/benchmark.js#L3645 "View in source") [Ⓣ][1] +# [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/master/benchmark.js#L3646 "View in source") [Ⓣ][1] *(Boolean)*: A flag to indicate if the emitters listener iteration is aborted. @@ -1905,7 +1905,7 @@ The Event constructor. ### `Benchmark.Event.prototype.cancelled` -# [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/master/benchmark.js#L3653 "View in source") [Ⓣ][1] +# [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/master/benchmark.js#L3654 "View in source") [Ⓣ][1] *(Boolean)*: A flag to indicate if the default action is cancelled. @@ -1917,7 +1917,7 @@ The Event constructor. ### `Benchmark.Event.prototype.result` -# [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/master/benchmark.js#L3669 "View in source") [Ⓣ][1] +# [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/master/benchmark.js#L3670 "View in source") [Ⓣ][1] *(Mixed)*: The return value of the last executed listener. @@ -1929,7 +1929,7 @@ The Event constructor. ### `Benchmark.Event.prototype.timeStamp` -# [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/master/benchmark.js#L3685 "View in source") [Ⓣ][1] +# [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/master/benchmark.js#L3686 "View in source") [Ⓣ][1] *(Number)*: A timestamp of when the event was created *(ms)*. @@ -1941,7 +1941,7 @@ The Event constructor. ### `Benchmark.Event.prototype.type` -# [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/master/benchmark.js#L3693 "View in source") [Ⓣ][1] +# [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/master/benchmark.js#L3694 "View in source") [Ⓣ][1] *(String)*: The event type. @@ -1960,7 +1960,7 @@ The Event constructor. ### `Benchmark.Event.prototype.currentTarget` -# [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/master/benchmark.js#L3661 "View in source") [Ⓣ][1] +# [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/master/benchmark.js#L3662 "View in source") [Ⓣ][1] *(Object)*: The object whose listeners are currently being processed. @@ -1979,7 +1979,7 @@ The Event constructor. ### `Benchmark.Event.prototype.target` -# [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/master/benchmark.js#L3677 "View in source") [Ⓣ][1] +# [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/master/benchmark.js#L3678 "View in source") [Ⓣ][1] *(Object)*: The object to which the event was originally emitted. @@ -2052,7 +2052,7 @@ var suite = new Benchmark.Suite('foo', { ### `Benchmark.Suite.prototype.aborted` -# [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/master/benchmark.js#L3734 "View in source") [Ⓣ][1] +# [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/master/benchmark.js#L3735 "View in source") [Ⓣ][1] *(Boolean)*: A flag to indicate if the suite is aborted. @@ -2064,7 +2064,7 @@ var suite = new Benchmark.Suite('foo', { ### `Benchmark.Suite.prototype.length` -# [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/master/benchmark.js#L3726 "View in source") [Ⓣ][1] +# [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/master/benchmark.js#L3727 "View in source") [Ⓣ][1] *(Number)*: The number of benchmarks in the suite. @@ -2076,7 +2076,7 @@ var suite = new Benchmark.Suite('foo', { ### `Benchmark.Suite.prototype.running` -# [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/master/benchmark.js#L3742 "View in source") [Ⓣ][1] +# [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/master/benchmark.js#L3743 "View in source") [Ⓣ][1] *(Boolean)*: A flag to indicate if the suite is running. @@ -2207,7 +2207,7 @@ An `Array#filter` like method. ### `Benchmark.Suite.prototype.forEach(callback)` -# [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/master/benchmark.js#L3752 "View in source") [Ⓣ][1] +# [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/master/benchmark.js#L3753 "View in source") [Ⓣ][1] An `Array#forEach` like method. Callbacks may terminate the loop by explicitly returning `false`. @@ -2225,7 +2225,7 @@ An `Array#forEach` like method. Callbacks may terminate the loop by explicitly r ### `Benchmark.Suite.prototype.indexOf(value)` -# [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/master/benchmark.js#L3761 "View in source") [Ⓣ][1] +# [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/master/benchmark.js#L3762 "View in source") [Ⓣ][1] An `Array#indexOf` like method. @@ -2243,7 +2243,7 @@ An `Array#indexOf` like method. ### `Benchmark.Suite.prototype.invoke(name [, arg1, arg2, ...])` -# [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/master/benchmark.js#L3771 "View in source") [Ⓣ][1] +# [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/master/benchmark.js#L3772 "View in source") [Ⓣ][1] Invokes a method on all benchmarks in the suite. @@ -2262,7 +2262,7 @@ Invokes a method on all benchmarks in the suite. ### `Benchmark.Suite.prototype.join([separator=','])` -# [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/master/benchmark.js#L3780 "View in source") [Ⓣ][1] +# [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/master/benchmark.js#L3781 "View in source") [Ⓣ][1] Converts the suite of benchmarks to a string. @@ -2298,7 +2298,7 @@ Returns an array of event listeners for a given type that can be manipulated to ### `Benchmark.Suite.prototype.map(callback)` -# [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/master/benchmark.js#L3789 "View in source") [Ⓣ][1] +# [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/master/benchmark.js#L3790 "View in source") [Ⓣ][1] An `Array#map` like method. @@ -2381,7 +2381,7 @@ bench.on('start cycle', listener); ### `Benchmark.Suite.prototype.pluck(property)` -# [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/master/benchmark.js#L3798 "View in source") [Ⓣ][1] +# [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/master/benchmark.js#L3799 "View in source") [Ⓣ][1] Retrieves the value of a specified property from all benchmarks in the suite. @@ -2399,7 +2399,7 @@ Retrieves the value of a specified property from all benchmarks in the suite. ### `Benchmark.Suite.prototype.pop()` -# [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/master/benchmark.js#L3806 "View in source") [Ⓣ][1] +# [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/master/benchmark.js#L3807 "View in source") [Ⓣ][1] Removes the last benchmark from the suite and returns it. @@ -2414,7 +2414,7 @@ Removes the last benchmark from the suite and returns it. ### `Benchmark.Suite.prototype.push()` -# [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/master/benchmark.js#L3814 "View in source") [Ⓣ][1] +# [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/master/benchmark.js#L3815 "View in source") [Ⓣ][1] Appends benchmarks to the suite. @@ -2429,7 +2429,7 @@ Appends benchmarks to the suite. ### `Benchmark.Suite.prototype.reduce(callback, accumulator)` -# [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/master/benchmark.js#L3833 "View in source") [Ⓣ][1] +# [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/master/benchmark.js#L3834 "View in source") [Ⓣ][1] An `Array#reduce` like method. @@ -2539,7 +2539,7 @@ Creates an array of the host array's elements from the start index up to, but no ### `Benchmark.Suite.prototype.sort([compareFn=null])` -# [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/master/benchmark.js#L3823 "View in source") [Ⓣ][1] +# [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/master/benchmark.js#L3824 "View in source") [Ⓣ][1] Sorts the benchmarks of the suite. @@ -2599,7 +2599,7 @@ Appends arguments to the host array. ### `Benchmark.Suite.options` -# [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/master/benchmark.js#L3705 "View in source") [Ⓣ][1] +# [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/master/benchmark.js#L3706 "View in source") [Ⓣ][1] *(Object)*: The default options copied by suite instances. @@ -2611,7 +2611,7 @@ Appends arguments to the host array. ### `Benchmark.Suite.options.name` -# [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/master/benchmark.js#L3713 "View in source") [Ⓣ][1] +# [Ⓢ](https://github.com/bestiejs/benchmark.js/blob/master/benchmark.js#L3714 "View in source") [Ⓣ][1] *(String)*: The name of the suite. diff --git a/vendor/docdown/README.md b/vendor/docdown/README.md index 5b0b38c4..7581efc7 100644 --- a/vendor/docdown/README.md +++ b/vendor/docdown/README.md @@ -1,4 +1,4 @@ -# Docdown v1.0.0-pre +# Docdown v1.0.0 A simple JSDoc to Markdown documentation generator. @@ -22,17 +22,6 @@ $markdown = docdown(array( )); ~~~ -## Cloning this repo - -To clone this repository just use: - -~~~ bash -git clone https://github.com/docdown/docdown.git -cd docdown -~~~ - -Feel free to fork and send pull requests if you see improvements! - ## Author * [John-David Dalton](http://allyoucanleet.com/)