format-duration.js

// adapted from https://github.com/sindresorhus/parse-ms.
// moved to internal function because parse-ms is now pure ESM.
function parseMs (ms) {
  if (typeof ms !== 'number') {
    throw new TypeError('Expected a number')
  }

  return {
    days: Math.trunc(ms / 86400000),
    hours: Math.trunc(ms / 3600000) % 24,
    minutes: Math.trunc(ms / 60000) % 60,
    seconds: Math.trunc(ms / 1000) % 60,
    ms: Math.trunc(ms) % 1000
  }
}

// adapted from https://github.com/rafaelrinaldi/add-zero.
// moved to internal function b/c addZero is unmaintained (7+ years).
// stripped out negative sign logic since we're already doing it elsewhere.
function addZero (value, digits) {
  digits = digits || 2

  let str = value.toString()
  let size = 0

  size = digits - str.length + 1
  str = new Array(size).join('0').concat(str)

  return str
}

function getSign (duration, showMs) {
  if (showMs) return duration < 0 ? '-' : ''
  return duration <= -1000 ? '-' : ''
}

/**
 * Convert a number in milliseconds to a standard duration string.
 * @param {number} ms - duration in milliseconds
 * @param {object} options - formatDuration options object
 * @param {boolean} [options.leading=false] - add leading zero
 * @param {boolean} [options.milliseconds=false] - add milliseconds
 * @returns string - formatted duration string
 */
function formatDuration (ms, options) {
  const leading = options && options.leading
  const showMs = options && options.ms
  const unsignedMs = ms < 0 ? -ms : ms
  const sign = getSign(ms, showMs)
  const t = parseMs(unsignedMs)
  const seconds = addZero(t.seconds)
  let output = ''

  if (t.days && !output) output = sign + t.days + ':' + addZero(t.hours) + ':' + addZero(t.minutes) + ':' + seconds
  if (t.hours && !output) output = sign + (leading ? addZero(t.hours) : t.hours) + ':' + addZero(t.minutes) + ':' + seconds
  if (!output) output = sign + (leading ? addZero(t.minutes) : t.minutes) + ':' + seconds

  if (showMs) output += '.' + addZero(t.ms, 3)
  return output
}

module.exports = formatDuration