index.js 2.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149
  1. /**
  2. * Helpers.
  3. */
  4. var s = 1000
  5. var m = s * 60
  6. var h = m * 60
  7. var d = h * 24
  8. var y = d * 365.25
  9. /**
  10. * Parse or format the given `val`.
  11. *
  12. * Options:
  13. *
  14. * - `long` verbose formatting [false]
  15. *
  16. * @param {String|Number} val
  17. * @param {Object} options
  18. * @throws {Error} throw an error if val is not a non-empty string or a number
  19. * @return {String|Number}
  20. * @api public
  21. */
  22. module.exports = function (val, options) {
  23. options = options || {}
  24. var type = typeof val
  25. if (type === 'string' && val.length > 0) {
  26. return parse(val)
  27. } else if (type === 'number' && isNaN(val) === false) {
  28. return options.long ?
  29. fmtLong(val) :
  30. fmtShort(val)
  31. }
  32. throw new Error('val is not a non-empty string or a valid number. val=' + JSON.stringify(val))
  33. }
  34. /**
  35. * Parse the given `str` and return milliseconds.
  36. *
  37. * @param {String} str
  38. * @return {Number}
  39. * @api private
  40. */
  41. function parse(str) {
  42. str = String(str)
  43. if (str.length > 10000) {
  44. return
  45. }
  46. var match = /^((?:\d+)?\.?\d+) *(milliseconds?|msecs?|ms|seconds?|secs?|s|minutes?|mins?|m|hours?|hrs?|h|days?|d|years?|yrs?|y)?$/i.exec(str)
  47. if (!match) {
  48. return
  49. }
  50. var n = parseFloat(match[1])
  51. var type = (match[2] || 'ms').toLowerCase()
  52. switch (type) {
  53. case 'years':
  54. case 'year':
  55. case 'yrs':
  56. case 'yr':
  57. case 'y':
  58. return n * y
  59. case 'days':
  60. case 'day':
  61. case 'd':
  62. return n * d
  63. case 'hours':
  64. case 'hour':
  65. case 'hrs':
  66. case 'hr':
  67. case 'h':
  68. return n * h
  69. case 'minutes':
  70. case 'minute':
  71. case 'mins':
  72. case 'min':
  73. case 'm':
  74. return n * m
  75. case 'seconds':
  76. case 'second':
  77. case 'secs':
  78. case 'sec':
  79. case 's':
  80. return n * s
  81. case 'milliseconds':
  82. case 'millisecond':
  83. case 'msecs':
  84. case 'msec':
  85. case 'ms':
  86. return n
  87. default:
  88. return undefined
  89. }
  90. }
  91. /**
  92. * Short format for `ms`.
  93. *
  94. * @param {Number} ms
  95. * @return {String}
  96. * @api private
  97. */
  98. function fmtShort(ms) {
  99. if (ms >= d) {
  100. return Math.round(ms / d) + 'd'
  101. }
  102. if (ms >= h) {
  103. return Math.round(ms / h) + 'h'
  104. }
  105. if (ms >= m) {
  106. return Math.round(ms / m) + 'm'
  107. }
  108. if (ms >= s) {
  109. return Math.round(ms / s) + 's'
  110. }
  111. return ms + 'ms'
  112. }
  113. /**
  114. * Long format for `ms`.
  115. *
  116. * @param {Number} ms
  117. * @return {String}
  118. * @api private
  119. */
  120. function fmtLong(ms) {
  121. return plural(ms, d, 'day') ||
  122. plural(ms, h, 'hour') ||
  123. plural(ms, m, 'minute') ||
  124. plural(ms, s, 'second') ||
  125. ms + ' ms'
  126. }
  127. /**
  128. * Pluralization helper.
  129. */
  130. function plural(ms, n, name) {
  131. if (ms < n) {
  132. return
  133. }
  134. if (ms < n * 1.5) {
  135. return Math.floor(ms / n) + ' ' + name
  136. }
  137. return Math.ceil(ms / n) + ' ' + name + 's'
  138. }