Skip to content

Latest commit

 

History

History
83 lines (56 loc) · 3.58 KB

README.md

File metadata and controls

83 lines (56 loc) · 3.58 KB
Raw

npm version Tests Status Coverage Status

Simple highly customized CLI-like progress bar for Javascript

If you get any questions or suggestions just open a discussion or an issue

Installation

This package is published in npmjs:

npm i @nathanpb/progress or yarn add @nathanpb/progress

If you want to try the unstable features, use the next tag: npm i @nathanpb/progress@next.

Basic example

import { initSimpleBar, ProgressBar, Tokens } from '@nathanpb/progress'

const bar = new ProgressBar({ total: 100 })
initSimpleBar({ 
  bar,
  template: '[$bar$] $progress$% | eta $eta$ s | elapsed $elapsed$ s',
  stream: process.stdout,
  tokens: {
    bar: Tokens.bar({ length: 30 }),
    eta: Tokens.eta({ interval: 1000 }),
    elapsed: Tokens.elapsedTime({ interval: 1000 }),
    progress: Tokens.progress({ decimalDigits: 2 })
  }
})

bar.on(Events.COMPLETED, () => console.log('Bar completed'))

setInterval(() => bar.tick(1), 500)

You can also group multiple progress bars:

initMultiBar({
  bars: [bar1, bar2, bar3],
  template: '$title$ [$bar$] $progress$% | eta $eta$ s | elapsed $elapsed$ s',
  tokens: {
    bar: Tokens.bar({ length: 30 }),
    eta: Tokens.eta({ interval: 1000 }),
    elapsed: Tokens.elapsedTime({ interval: 1000 }),
    progress: Tokens.progress({ decimalDigits: 2 }),
    title: Tokens.title()
  },
  stream: process.stdout
})

The above code is a shortcut to the full version. If you want to take control over the customization, check the Under the Hood page.

Also, check the examples page.

Downsides

Compared to other similar libraries (special thanks to node-progress which was my inspiration), this lib is a bit overcomplicated. So if you want something dead simple, their solution might suit better for your use case.

License

Copyright 2021 Nathan P. Bombana

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Do whatever you want with my code just don't make it boring