tiny-status

Status progresser for terminals.

npm i tiny-status

Usage

const tinyStatus = require('tiny-status')

const progresser = tinyStatus()

progresser('Starting stage')
setTimeout(() => progresser('Staging files (1/3)'), 1000)
setTimeout(() => progresser('Staging files (2/3)'), 2000)
setTimeout(() => progresser('Staging files (3/3)'), 3000)
setTimeout(() => progresser.end('Files are staged'), 4000)

setTimeout(() => progresser('Start again!'), 5000)
setTimeout(() => progresser.end('First stage was completed'), 6000)
setTimeout(() => progresser.success('File is saved successfully'), 6500)
setTimeout(() => progresser.error('An error occurred'), 7000)
setTimeout(() => progresser.warning('Caution with this operation'), 7500)
setTimeout(() => progresser.info('Time estimation is 2 minutes'), 8000)

end() is like success(), error(), etc but without icon frame.

const progresser = tinyStatus({ frames: ['-'], color: 'gray' })

const progresser = tinyStatus({ frames: ['-', '+', '-'], interval: 80 })

Default std stream used is stderr:

const progresser = tinyStatus({ stream: process.stderr })

License

MIT