Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Break]: Golfing w/ Performance tuning #120

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,6 @@ node_modules

# logs
npm-debug.log

# built files
/dist
42 changes: 42 additions & 0 deletions bench.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
/* eslint no-console: 0 */
const { Suite } = require('benchmark');
const ms = require('./dist');

function bench(name) {
console.log(`\n# ${name}`);
const suite = new Suite();
suite.on('cycle', e => console.log(' ' + e.target));
return suite;
}

bench('string (short) -> number')
.add('ms ', () => ms('1d'))
.run();

bench('string (long) -> number')
.add('ms ', () => ms('10 hours'))
.run();

bench('number -> string (short)')
.add('ms ', () => ms(31557600000))
.run();

bench('number -> string (long)')
.add('ms ', () => ms(31557600000, true))
.run();

bench('Negative :: string (short) -> number')
.add('ms ', () => ms('-1d'))
.run();

bench('Negative :: string (long) -> number')
.add('ms ', () => ms('-10 hours'))
.run();

bench('Negative :: number -> string (short)')
.add('ms ', () => ms(-31557600000))
.run();

bench('Negative :: number -> string (long)')
.add('ms ', () => ms(-31557600000, true))
.run();
142 changes: 44 additions & 98 deletions index.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,161 +2,107 @@
* Helpers.
*/

var s = 1000;
var s = 1e3;
var m = s * 60;
var h = m * 60;
var d = h * 24;
var w = d * 7;
var y = d * 365.25;

var rgx = /^(-?(?:\d+)?\.?\d+) *([a-z]+)?$/;

/**
* Parse or format the given `val`.
*
* Options:
*
* - `long` verbose formatting [false]
*
* @param {String|Number} val
* @param {Object} [options]
* @param {Boolean} toLong verbose string formatting [false]
* @throws {Error} throw an error if val is not a non-empty string or a number
* @return {String|Number}
* @api public
*/

module.exports = function(val, options) {
options = options || {};
var type = typeof val;
export default function(val, toLong) {
var abs,
fmt,
type = typeof val;

if (type === 'string' && val.length > 0) {
return parse(val);
} else if (type === 'number' && isFinite(val)) {
return options.long ? fmtLong(val) : fmtShort(val);
if ((fmt = val.length < 101 && val.toLowerCase().match(rgx))) {
if ((abs = parseFloat(fmt[1], 10))) {
return convert(abs, fmt[2]);
}
}
return abs;
}

if (type === 'number' && isFinite(val)) {
fmt = plural.bind(plural, toLong, val, (abs = Math.abs(val)));

if (abs >= d) return fmt(d, 'day', 'd');
if (abs >= h) return fmt(h, 'hour', 'h');
if (abs >= m) return fmt(m, 'minute', 'm');
if (abs >= s) return fmt(s, 'second', 's');

return val + (toLong ? ' ' : '') + 'ms';
}

throw new Error(
'val is not a non-empty string or a valid number. val=' +
JSON.stringify(val)
'val is an empty string or an invalid number. val=' + JSON.stringify(val)
);
};
}

/**
* Parse the given `str` and return milliseconds.
* Convert the `str` segments into milliseconds.
*
* @param {String} str
* @param {Array} arr The RegExp matches
* @return {Number}
* @api private
*/

function parse(str) {
str = String(str);
if (str.length > 100) {
return;
}
var match = /^(-?(?:\d+)?\.?\d+) *(milliseconds?|msecs?|ms|seconds?|secs?|s|minutes?|mins?|m|hours?|hrs?|h|days?|d|weeks?|w|years?|yrs?|y)?$/i.exec(
str
);
if (!match) {
return;
}
var n = parseFloat(match[1]);
var type = (match[2] || 'ms').toLowerCase();
function convert(num, type) {
switch (type) {
case 'years':
case 'year':
case 'yrs':
case 'yr':
case 'y':
return n * y;
return num * y;
case 'weeks':
case 'week':
case 'w':
return n * w;
return num * d * 7;
case 'days':
case 'day':
case 'd':
return n * d;
return num * d;
case 'hours':
case 'hour':
case 'hrs':
case 'hr':
case 'h':
return n * h;
return num * h;
case 'minutes':
case 'minute':
case 'mins':
case 'min':
case 'm':
return n * m;
return num * m;
case 'seconds':
case 'second':
case 'secs':
case 'sec':
case 's':
return n * s;
case 'milliseconds':
case 'millisecond':
case 'msecs':
case 'msec':
case 'ms':
return n;
default:
return undefined;
}
}

/**
* Short format for `ms`.
*
* @param {Number} ms
* @return {String}
* @api private
*/

function fmtShort(ms) {
var msAbs = Math.abs(ms);
if (msAbs >= d) {
return Math.round(ms / d) + 'd';
}
if (msAbs >= h) {
return Math.round(ms / h) + 'h';
}
if (msAbs >= m) {
return Math.round(ms / m) + 'm';
}
if (msAbs >= s) {
return Math.round(ms / s) + 's';
}
return ms + 'ms';
}

/**
* Long format for `ms`.
*
* @param {Number} ms
* @return {String}
* @api private
*/

function fmtLong(ms) {
var msAbs = Math.abs(ms);
if (msAbs >= d) {
return plural(ms, msAbs, d, 'day');
return num * s;
}
if (msAbs >= h) {
return plural(ms, msAbs, h, 'hour');
}
if (msAbs >= m) {
return plural(ms, msAbs, m, 'minute');
}
if (msAbs >= s) {
return plural(ms, msAbs, s, 'second');
}
return ms + ' ms';
return num;
}

/**
* Pluralization helper.
*/

function plural(ms, msAbs, n, name) {
var isPlural = msAbs >= n * 1.5;
return Math.round(ms / n) + ' ' + name + (isPlural ? 's' : '');
function plural(isLong, ms, abs, interval, l1, l2) {
return (
Math.round(ms / interval) +
(isLong ? ' ' + l1 + (abs >= interval * 1.5 ? 's' : '') : l2)
);
}