Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More →
baseline - npm Package Compare versions
Comparing version 0.1.4 to 0.1.5
| { | ||
| "name": "baseline", | ||
| "description": "A benchmarking library that allows performance to be compared to an established baseline.", | ||
| "version": "0.1.4", | ||
| "version": "0.1.5", | ||
| "author": { | ||
@@ -6,0 +6,0 @@ "name": "Artifact Health, LLC", |
| # Baseline | ||
| This is a work in progress. Check back in a couple weeks. | ||
| Baseline is a benchmarking framework for [node.js](http://nodejs.org/) where the results of a test run can be saved and | ||
| used to determine if the performance of a test changes in the future. | ||
| Baseline is inspired by and incorporates code from two projects: [Benchmark.js](http://benchmarkjs.com/) and | ||
| [mocha](http://mochajs.org/). | ||
| ## Table of contents | ||
| * [`A note on micro-benchmarks`](#micro-benchmarks) | ||
| * [`Installation`](#installation) | ||
@@ -18,16 +21,5 @@ * [`Test suites`](#test-suites) | ||
| * [`Reporters`](#reporters) | ||
| * [`A note on micro-benchmarks`](#micro-benchmarks) | ||
| <a name="micro-benchmarks" /> | ||
| ## A note on micro-benchmarks | ||
| Baseline cannot be used for micro-benchmarks such as determining if == or === is faster. The time required to call the | ||
| test function is generally greater than the time to execute the test itself. The [Benchmark.js](http://benchmarkjs.com/) | ||
| library is able run micro-benchmarks because it dynamically creates a function, when possible, that compiles the test case into | ||
| the test loop. Baseline does not do this. However, even this technique of dynamically creating the test function is not | ||
| possible for asynchronous tests or tests that reference variables from an outer scope. Regardless, V8 compiler | ||
| optimizations can make micro-benchmarks unreliable. Please see [this video](https://www.youtube.com/watch?v=65-RbBwZQdU) | ||
| for more information. | ||
| <a name="installation" /> | ||
@@ -270,5 +262,17 @@ ## Installation | ||
| The minimal reporter only reports results for tests that have changed from baseline. Otherwise, only the | ||
| The minimal reporter only outputs results for tests that have changed from baseline. Otherwise, only the | ||
| summary is reported. | ||
|  | ||
|  | ||
| <a name="micro-benchmarks" /> | ||
| ## A note on micro-benchmarks | ||
| Baseline cannot be used for micro-benchmarks such as determining if == or === is faster. The time required to call the | ||
| test function is generally greater than the time to execute the test itself. The [Benchmark.js](http://benchmarkjs.com/) | ||
| library is able run micro-benchmarks because it dynamically creates a function, when possible, that compiles the test case into | ||
| the test loop. Baseline does not do this. However, even this technique of dynamically creating the test function is not | ||
| possible for asynchronous tests or tests that reference variables from an outer scope. Regardless, V8 compiler | ||
| optimizations can make micro-benchmarks unreliable. Please see [this video](https://www.youtube.com/watch?v=65-RbBwZQdU) | ||
| for more information. |
New alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Fixed alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Improved metrics
- Total package byte prevSize
- increased by0.37%
73146
- Number of lines in readme file
- increased by1.47%
276
No dependency changes