default | /mod.ts | progress@v1.4.2

class default

import { default } from "https://deno.land/x/progress@v1.4.2/mod.ts";

Constructors

new

default(unnamed 0?: constructorOptions)

Title, total, complete, incomplete, can also be set or changed in the render method

title Progress bar title, default: ''
total total number of ticks to complete,
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: ':title :percent :bar :time :completed/:total'
prettyTime Whether to pretty print time and eta

Properties

private

encoder: TextEncoder

private

lastRenderTime: number

private

lastStr: string

private

lastStrLen: number

private

start

private

readonly

ttyColumns: number

private

writer

clear: boolean

complete: string

display: string

incomplete: string

interval: number

preciseBar: string[]

prettyTime: boolean

title: string

optional

total: number

width: number

Methods

private

breakLine()

private

clearLine(direction?: Direction): void

private

showCursor(): void

private

stdoutWrite(msg: string)

private

write(msg: string): void

console(message: string | number): void

interrupt the progress bar and write a message above it

end(): void

end: end a progress bar. No need to call in most cases, unless you want to end before 100%

render(completed: number, options?: renderOptions): void

"render" the progress bar

completed completed value
options optional parameters
- title progress bar title
- total total number of ticks to complete
- text optional, custom text, default: ''
- complete completion character, If you want to change at a certain moment. For example, it turns red at 20%
- incomplete incomplete character, If you want to change at a certain moment. For example, it turns red at 20%
- prettyTimeOptions prettyTime options