radargun/lib/index.js

A benchmark utility for Node.js.

'use strict';

const bench = require('./bench');
const errors = require('./errors');


/**
 * Easy to use benchmarking utility for Node.js. Provides high-precision
 * execution time metrics for: average, min, and max.
 *
 * @module radargun
 *
 * @prop {object} errors - References to error types thrown by radargun
 * @prop {function} ThresholdError - Thrown when target thresholds are not met
 */
module.exports =
{
  /**
   * @method bench
   */
  bench,

  errors,
};