import { MultiProgressBar } from "https://deno.land/x/progress@v1.4.5/multi.ts";
Constructors
Title, total, complete, incomplete, can also be set or changed in the render method
- title Progress bar title, default: ''
- width the displayed width of the progress, default: 50
- complete completion character, default: colors.bgGreen(' '), can use any string
- incomplete incomplete character, default: colors.bgWhite(' '), can use any string
- clear clear the bar on completion, default: false
- interval minimum time between updates in milliseconds, default: 16
- display What is displayed and display order, default: ':bar :text :percent :time :completed/:total'
- prettyTime Whether to pretty print time and eta
Properties
private
encoder: TextEncoderMethods
private
breakLine(): Promise<void>private
resetScreen(): Promise<void>private
showCursor(): Promise<void>private
stdoutWrite(msg: string): Promise<void>private
write(msg: string): Promise<void>console(message: string | number): Promise<void>
interrupt the progress bar and write a message above it
end(): Promise<void>
end: end a progress bar. No need to call in most cases, unless you want to end before 100%
render(bars: Array<renderOptions>): Promise<void>
"render" the progress bar
bars
progress barscompleted
completed valuetotal
optional, total number of ticks to complete, default: 100text
optional, text displayed per ProgressBar, default: ''complete
- optional, completion characterincomplete
- optional, incomplete characterprettyTimeOptions
- prettyTime options