Skip to content

Class: ProgressBar<T> ​

Defined in: src/helpers/progress.ts:8

Minimal text progress bar — mirrors pymupdf4llm.helpers.progress.ProgressBar.

Wraps an iterable so consumers can do for (const x of new ProgressBar(list)) and see a progress line on stderr. Cosmetic only; the heavy work is in the caller.

Type Parameters ​

T ​

T

Implements ​

  • Iterable<T>

Constructors ​

Constructor ​

ts
new ProgressBar<T>(items, opts?): ProgressBar<T>;

Defined in: src/helpers/progress.ts:14

Parameters ​

items ​

Iterable<T>

opts? ​
prefix? ​

string

stream? ​

{ write: void; }

stream.write ​
width? ​

number

Returns ​

ProgressBar<T>

Accessors ​

length ​

Get Signature ​

ts
get length(): number;

Defined in: src/helpers/progress.ts:24

Returns ​

number

Methods ​

[iterator]() ​

ts
iterator: IterableIterator<T>;

Defined in: src/helpers/progress.ts:28

Returns ​

IterableIterator<T>

Implementation of ​

ts
Iterable.[iterator]

AGPL-3.0-or-later — inherited from PyMuPDF and pymupdf4llm.