lapse

command-line progress bar

install

 
$ npm install lapse
 

examples

 
$ node -e "require('repl').start({ignoreUndefined: true})"   # repl formatting
 

 
> var lapse = require('lapse')
> lapse( 60 )
 
 |⋅⋅⋅⋅⋅⋅⋅⋅⋅⋅⋅⋅⋅⋅⋅⋅⋅⋅⋅⋅⋅⋅⋅⋅⋅⋅⋅⋅⋅⋅⋅⋅⋅⋅⋅⋅⋅⋅⋅⋅⋅⋅⋅⋅⋅⋅⋅⋅⋅⋅⋅ 60.0  
 
> lapse( 60, { format: " #mtime [#bar] #percent% #secondss " } )
 
 00:47 [⋅⋅⋅⋅⋅⋅⋅⋅⋅⋅⋅|⋅⋅⋅⋅⋅⋅⋅⋅⋅⋅⋅⋅⋅⋅⋅⋅⋅⋅⋅⋅⋅⋅⋅⋅⋅] 100.0% 15.0s 
 
> lapse( 60, { car_char: "✂ ", road_char: "-" } )
 
 -------------------------✂ ------------------------- 30.0  
 
> lapse( 600, { car_char: "\u001b[36m☂ \u001b[0m" } )
 
 ⋅⋅⋅⋅⋅⋅⋅⋅⋅⋅⋅⋅⋅⋅⋅⋅⋅⋅⋅⋅⋅⋅⋅⋅⋅⋅⋅⋅⋅⋅⋅⋅⋅⋅⋅⋅⋅⋅⋅☂ ⋅⋅⋅⋅⋅⋅⋅⋅⋅⋅⋅ 2:30  
 
> lapse( 60, { trail: true } )
 
 |||||||||||||||||||||||||||⋅⋅⋅⋅⋅⋅⋅⋅⋅⋅⋅⋅⋅⋅⋅⋅⋅⋅⋅⋅⋅⋅⋅⋅⋅ 30.0  
 
 

use

press space to pause/play

options

• stream stream
  • the output stream
  • defaults to process.stderr
• width int
  • the width of the lapse bar and stats
  • defaults to terminal-width (process.stderr.columns)
• car_char string
  • the character that travels across the lapse bar
  • defaults to |
• road_char string
  • the character that is used everywhere around the car_char
  • defaults to ⋅
• trail bool
  • creates a repeated trail behind the car_char
  • defaults to false
• clear bool
  • clears the bar upon completion
  • defaults to false
• callback function
  • function to execute upon completion
• refresh_rate int
  • the refresh rate of the lapse line
    • occurs every 1000 / refresh_rate milliseconds
  • defaults to 100
• format string
  • lapse line formatting: tags are replaced by dynamic values
    • #bar displays the bar animation
    • #percent displays completion percentage
    • #eta displays a formatted time to completion
    • #seconds displays number of elapsed seconds
    • #elapsed displays formatted elapsed time
    • #time displays current 12-hour time
    • #mtime displays current 24-hour time
    • #start displays start time as 12-hour
    • #mstart displays start time as 24-hour
  • defaults to #bar #eta

acknowledgements

• thanks to @tj for making node-progress