progress-string/index.js

Get a progess bar as a string

'use strict'

module.exports = function (opts) {
  if (!Number.isFinite(opts.total)) throw new Error('missing required opts.total')

  var width = opts.width || 42
  var total = opts.total
  var incomplete = Array(width + 1).join(opts.incomplete || '-')
  var complete = Array(width + 1).join(opts.complete || '=')
  var style = opts.style || defaultStyle
  var unit = total / width

  return function (value) {
    var chars = unit === 0 ? width : Math.floor(value / unit)
    if (value >= total) chars = complete.length
    return style(complete.slice(0, chars), incomplete.slice(chars))
  }
}

function defaultStyle (complete, incomplete) {
  return complete + incomplete
}