@prantlf/astrobench NPM

@prantlf/astrobench

Make the Web Faster

JavaScript library for running in the browser performance benchmarks, based on Benchmark.js. Try the live demo.

Easy way to create test cases. Provides rich and pretty UI.

This fork enhances the original project with the following functionality:

Includes the most recent version of Benchmark.js.
Publishes minified script and stylesheet to reduce page loading times.
Offers global functions beforeBench afterBench, beforeSuite and afterSuite to register setup and teardown callbacks for the tests.
Offers global functions suiteOptions and benchOptions to set options for all suites and benchmarks.
Can disable emphasizing the fastest test and showing by how many percent are the others slower.
Allows command-line usage via astrobench-cli.

With Installation

Make sure that you have Node.js >= 8 installed. Install astrobench with npm or yarn:

npm i @prantlf/astrobench
yarn add @prantlf/astrobench

Without Installation

Instead of installing the package locally, you can load the script and stylesheet in the example below from unpkg. The URLs will look like this:

<link rel="stylesheet"
      href="https://unpkg.com/@prantlf/astrobench@1.1.0/dist/astrobench.min.css">
<script src="https://unpkg.com/@prantlf/astrobench@1.1.0/dist/astrobench.min.js"></script>

Usage

Create a HTML file in the directory where you installed the package, or anywhere using the URLs from unpkg above:

<!DOCTYPE html>
<html lang="en">
<head>
  <meta charset="UTF-8">
  <title>Performance Tests</title>
  <link rel="stylesheet" href="node_modules/@prantlf/astrobench/dist/astrobench.min.css">
</head>
<body>
  <!-- Wrapper for tests -->
  <div id="astrobench"></div>

  <script src="node_modules/@prantlf/astrobench/dist/astrobench.min.js"></script>
  <script>
    // A test suite begins with a call to the global function `suite`
    // with two parameters: a string and a function.
    // The string is a name or title for a spec suite – usually what is being
    // tested. The function is a block of code that implements the suite.
    suite('String matching', function(suite) {
      var text;

      // To help a test suite DRY up any duplicated setup code, provides
      // the global `beforeBench` functions. As the name implies,
      // this function is called once before each benchmark is executed.
      // You can store data in `suite` Object, or define necessary variables.
      // Code from body of the functions will be presented in UI.
      beforeBench(function() {
        suite.text = 'Hello world';
        text = 'Hello world';
      });

      // Benchmarks are defined by calling the global function `bench`,
      // which, like `suite` takes a string and a function.
      // The string is the title of the test and the function is the test.
      bench('String#match', function() {
        !! text.match(/o/);
      });

      bench('RegExp#test', function() {
        !! /o/.test(suite.text);
      });

      // Async benchmark.
      // Calls to `bench` can take an optional single argument, Deferred object,
      // method .resolve() should be called when the async work is complete.
      bench('Async#test', function(deferred) {
        setTimeout(function() {
          deferred.resolve();
        }, 100);
      },
      // Options for current benchmark
      // See more on http://benchmarkjs.com/docs#options
      {
        defer: true
      });
    });
  </script>
</body>
</html>

And enjoy the result.

Contributing

In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using Grunt.