index.js

/*!
 * log-time <https://github.com/jonschlinkert/log-time>
 *
 * Copyright (c) 2015, Jon Schlinkert.
 * Licensed under the MIT License.
 */

'use strict';

var extend = require('extend-shallow');
var isNumber = require('is-number');
var pretty = require('pretty-time');
var log = require('log-utils');

/**
 * Create an instance of `Time`, optionally specifying the
 * time-scale to use and/or the number of decimal places to display.
 *
 * ```js
 * var time = new Time('s', 3);
 * ```
 * @param {String|Number} `smallest` The smallest time scale to show, or the number of decimal places to display
 * @param {Number} `digits` The number of decimal places to display
 */

function Time(options) {
  if (!(this instanceof Time)) {
    return new Time(options);
  }

  this.options = options || {};
  var smallest = this.options.smallest;
  var digits = this.options.digits;

  if (isNumber(smallest)) {
    digits = smallest;
    smallest = null;
  }

  this.smallest = smallest;
  this.digits = digits;
  this.times = {};
}

/**
 * Start a timer for the given `name`.
 *
 * ```js
 * var time = new Time();
 * time.start('foo');
 * ```
 * @param {String} `name` Name to use for the starting time.
 * @return {Array} Returns the array from `process.hrtime()`
 * @api public
 */

Time.prototype.start = function(name) {
  return (this.times[name] = process.hrtime());
};

/**
 * Returns the cumulative elapsed time since the **first time** `time.start(name)`
 * was called.
 *
 * ```js
 * var time = new Time();
 * time.start('foo');
 *
 * // do stuff
 * time.end('foo');
 * //=> 104μs
 *
 * // do more stuff
 * time.end('foo');
 * //=> 1ms
 *
 * // do more stuff
 * time.end('foo');
 * //=> 2ms
 * ```
 * @param {String} `name` The name of the cached starting time to create the diff
 * @return {Array} Returns the array from `process.hrtime()`
 * @api public
 */

Time.prototype.end = function(name, smallest, digits) {
  var start = this.times[name];
  if (typeof start === 'undefined') {
    throw new Error(log.colors.red('start time not defined for "' + name + '"'));
  }

  if (isNumber(smallest)) {
    digits = smallest;
    smallest = null;
  }

  if (!smallest && this.smallest) smallest = this.smallest;
  if (!digits && this.digits) digits = this.digits;
  return pretty(process.hrtime(start), smallest, digits);
};

/**
 * Returns a function for logging out out both the cumulative elapsed time since
 * the first time `.diff(name)` was called, as well as the incremental elapsed
 * time since the last `.diff(name)` was called. Unlike `.end()`, this method logs
 * to `stderr` instead of returning a string. We could probably change this to
 * return an object, feedback welcome.
 *
 * ```js
 * var time = new Time();
 * var diff = time.diff('my-app-name');
 *
 * // do stuff
 * diff('after init');
 * //=> [19:44:05] my-app-name: after init 108μs
 *
 * // do more stuff
 * diff('before options');
 * //=> [19:44:05] my-app-name: before options 2ms (+2ms)
 *
 * // do more stuff
 * diff('after options');
 * //=> [19:44:05] my-app-name: after options 2ms (+152μs)
 * ```
 * Results in something like:
 * <br>
 * <img width="509" alt="screen shot 2016-04-13 at 7 45 12 pm" src="https://cloud.githubusercontent.com/assets/383994/14512800/478e1256-01b0-11e6-9e97-c6b625f097f7.png">
 *
 * @param {String} `name` The name of the starting time to store.
 * @param {String} `options`
 * @api public
 */

Time.prototype.diff = function(namespace, options) {
  var opts = {};
  extend(opts, this.options, options);

  this.start(namespace);
  var time = this;
  var prev;

  function diff(msg) {
    if (typeof opts.logTimeDiffs !== 'undefined') {
      opts.logDiff = opts.logTimeDiffs;
    }

    if (typeof opts.logDiff === 'string') {
      if (!toRegex(opts.logDiff).test(namespace)) {
        // garbage collect
        time.times[namespace] = null;
        return;
      }
    }
    if (opts.logDiff === false) {
      // garbage collect
      time.times[namespace] = null;
      return;
    }

    var timestamp = log.timestamp;
    var magenta = log.colors.magenta;
    var gray = log.colors.gray;
    var name = opts.prefix === false ? '' : namespace;

    if (typeof opts.diffColor === 'function') {
      gray = opts.diffColor;
    }

    if (opts.nocolor === true) {
      magenta = identity;
      gray = identity;
    }

    if (opts.timestamp === false) {
      timestamp = '';
    }

    var elapsed = magenta(time.end(namespace));
    var val;

    if (typeof prev !== 'undefined') {
      val = time.end(prev);
    }

    // start the next cycle
    time.start(msg);
    prev = msg;

    if (typeof val === 'string') {
      elapsed += gray(' (+' + val + ')');
    }

    // create the arguments to log out
    var args = [timestamp, name, msg, elapsed].filter(Boolean);

    // support custom `.format` function
    if (typeof opts.formatArgs === 'function') {
      args = [].concat(opts.formatArgs.apply(null, args) || []);
    }

    console.error.apply(console, args);
  };

  return diff;
};

function toRegex(str) {
  if (~str.indexOf(',')) {
    str = '(' + str.split(',').join('|') + ')';
  }
  str = str.replace(/\*/g, '[^.]*?');
  return new RegExp('^' + str + '$');
}

function identity(val) {
  return val;
}

/**
 * Expose `time`
 */

module.exports = Time;