Class Progress

Index

Constructors

Accessors

Methods

[dispose] print start stop text update

Constructors

constructor

new Progress(length?: number): Progress
Parameters
- length: number = 1
Returns Progress
- Defined in index.ts:94

Accessors

running

get running(): boolean
true while rendering.

Returns boolean
- Defined in index.ts:167

Methods

[dispose]

"[dispose]"(): void
using progress = Progress.of(2).start() stops rendering when the scope ends.

Returns void
- Defined in index.ts:172

print

print(): void
Returns void
- Defined in index.ts:123

start

start(fps?: number, __namedParameters?: { signal?: AbortSignal }): Progress
Starts rendering fps times per second. A running progress is restarted.
Parameters
- fps: number = 12
- __namedParameters: { signal?: AbortSignal } = {}
Returns Progress
- Defined in index.ts:146

stop

stop(): void
Stops rendering: clears the interval and detaches from the start signal, if any. Idempotent.

Returns void
- Defined in index.ts:132

text

text(index?: number): string
Parameters
- index: number = 0
Returns string
- Defined in index.ts:102

update

update(__namedParameters: Partial<{ index: number } & Worker>): void
Parameters
- __namedParameters: Partial<{ index: number } & Worker>
Returns void
- Defined in index.ts:107