### Hierarchy

- Options

## Index

### Properties

- barCompleteChar
- barCompleteString
- barIncompleteChar
- barIncompleteString
- barsize
- clearOnComplete
- etaBuffer
- format
- fps
- hideCursor
- linewrap
- stopOnComplete
- stream

## Properties

### Optional barCompleteChar

barCompleteChar: undefined | string

- Defined in node_modules/@types/cli-progress/index.d.ts:51

character to use as "complete" indicator in the bar (default: "=")

### Optional barCompleteString

barCompleteString: undefined | string

- Defined in node_modules/@types/cli-progress/index.d.ts:45

character to use as "complete" indicator in the bar (default: "=")

### Optional barIncompleteChar

barIncompleteChar: undefined | string

- Defined in node_modules/@types/cli-progress/index.d.ts:54

character to use as "incomplete" indicator in the bar (default: "-")

### Optional barIncompleteString

barIncompleteString: undefined | string

- Defined in node_modules/@types/cli-progress/index.d.ts:48

character to use as "incomplete" indicator in the bar (default: "-")

### Optional barsize

barsize: undefined | number

- Defined in node_modules/@types/cli-progress/index.d.ts:42

the length of the progress bar in chars (default: 40)

### Optional clearOnComplete

clearOnComplete: undefined | false | true

- Defined in node_modules/@types/cli-progress/index.d.ts:39

clear the progress bar on complete / stop() call (default: false)

### Optional etaBuffer

etaBuffer: undefined | number

- Defined in node_modules/@types/cli-progress/index.d.ts:60

number of updates with which to calculate the eta; higher numbers give a more stable eta (default: 10)

### Optional format

format: undefined | string

- Defined in node_modules/@types/cli-progress/index.d.ts:27

progress bar output format. The progressbar can be customized by using the following build-in placeholders. They can be combined in any order. {bar} - the progress bar, customizable by the options barsize, barCompleteString and barIncompleteString {percentage} - the current progress in percent (0-100) {total} - the end value {value} - the current value set by last update() call {eta} - expected time of accomplishment in seconds {duration} - elapsed time in seconds {eta_formatted} - expected time of accomplishment formatted into appropriate units {duration_formatted} - elapsed time formatted into appropriate units

Example: progress [{bar}] {percentage}% | ETA: {eta}s | {value}/{total} is rendered as progress [========================================] 100% | ETA: 0s | 200/200

### Optional fps

fps: undefined | number

- Defined in node_modules/@types/cli-progress/index.d.ts:30

the maximum update rate (default: 10)

### Optional hideCursor

hideCursor: undefined | false | true

- Defined in node_modules/@types/cli-progress/index.d.ts:57

hide the cursor during progress operation; restored on complete (default: false)

### Optional linewrap

linewrap: boolean | null

- Defined in node_modules/@types/cli-progress/index.d.ts:63

disable line wrapping (default: false) - pass null to keep terminal settings; pass true to trim the output to terminal width

### Optional stopOnComplete

stopOnComplete: undefined | false | true

- Defined in node_modules/@types/cli-progress/index.d.ts:36

automatically call stop() when the value reaches the total (default: false)

### Optional stream

stream: WritableStream

- Defined in node_modules/@types/cli-progress/index.d.ts:33

output stream to use (default: process.stderr)

Generated using TypeDoc