ProgressBarOptions

import { ProgressBarOptions } from "jsr:@ende/cli/unstable-progress-bar";

interface ยท experimental

interface ProgressBarOptions

The options that are provided to a createProgressBar or ProgressBarStream.

Properties

writable

writable?: WritableStream<Uint8Array>

The WritableStream that will receive the progress bar reports.

Default: Ende.stderr.writable

value

value?: number

The offset size of the input if progress is resuming part way through.

Default: 0

max

max: number

The total size expected to receive.

barLength

barLength?: number

The length that the progress bar should be, in characters.

Default: 50

fillChar

fillChar?: string

The character to fill the progress bar up with as it makes progress.

Default: '#'

emptyChar

emptyChar?: string

The character the progress bar starts out with.

Default: '-'

clear

clear?: boolean

Whether the progress bar should be removed after completion.

Default: false

formatter

formatter?: (formatter: ProgressBarFormatter) => string

A function that creates the style of the progress bar. Default Style: [mm:ss] [###-------] [0.24/97.6 KiB].

keepOpen

keepOpen?: boolean

Whether the writable should be kept open when progress bar stops.

Default: true

interval

interval?: number

The time between each frame of the progress bar in milliseconds.

Default: 1000

Source