Package Exports

parse-human-timeout-duration

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (parse-human-timeout-duration) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

parse-human-timeout-duration

Basically timestring-notsep but checks the range limits for valid JS setTimeout() timespans.

API

This module exports one function:

parseHumanTimeoutDuration(dura[, opts])

Takes a human-readable timespan dura. Returns false (see below) or a number (see below).

opts is an optional options object that supports these keys:

optional: If true and dura is one of the non-durations false, 'never' or 'off', return false instead of complaining.
unit: Desired unit of measurement for the result number. Can be 'sec' (default) or 'ms'.
min: Complain if the result would be less than this. Defaults to 0.
descr: Text to annotate error messages with if an error occurrs.
lookup: A dictionary object. dura is used as the key to look up the real duration.

Usage

from usage.js:

var phtd = require('parse-human-timeout-duration'),
  timeouts = { read: '0.2 sec' };

equal(phtd('2.5 minutes'), 150);
equal(phtd('2.5 minutes', { unit: 'ms' }), 150e3);
throws(phtd, [timeouts.read, { min: 1 }],
  /Timespan must be at least 1 sec/);
throws(phtd, [timeouts.read, { min: 500, unit: 'ms' }],
  /Timespan must be at least 500 ms/);
throws(phtd, ['1 year'], /^RangeError: Timespan too long/);
throws(phtd, ['0 sec'], /Timespan must be positive$/);
throws(phtd, ['0 sec', { optional: true }],
  /Timespan must be positive, or "false" to disable/);
throws(phtd, [false], /Timespan required/);
equal(phtd(false, { optional: true }), false);
throws(phtd, ['false'], /Invalid duration: Found no number/);
throws(phtd, ['false', { optional: true }],
  /Invalid duration: Found no number/);

throws(phtd, ['never'], /Timespan required/);
equal(phtd('never', { optional: true }), false);
equal(phtd('off', { optional: true }), false);

throws(phtd, ['0 ms', { descr: 'database timeout' }],
  /RangeError: database timeout: Timespan must be positive/);

equal(phtd('read', { lookup: timeouts }), 0.2);
throws(phtd, ['write', { lookup: timeouts }],
  /InvalidDuration: write: Invalid duration: Found no time unit/);
throws(phtd, ['write', { lookup: timeouts, descr: 'database config' }],
  /InvalidDuration: database config \[write\]: Invalid/);

Known issues

Needs more/better tests and docs.

License

ISC