@graphty/graphty-element / session / Progress
Interface: Progress ​
Defined in: graphty-element/src/session/runs/types.ts:146
How far a run has got.
fraction is null while the work is indeterminate, and it stays null: a percentage invented for a progress bar that has nothing to measure is worse than a spinner, because it tells the reader a lie they will time their patience against.
Properties ​
completed ​
readonlycompleted:number
Defined in: graphty-element/src/session/runs/types.ts:152
How many units are done.
determinate ​
readonlydeterminate:boolean
Defined in: graphty-element/src/session/runs/types.ts:150
Whether the total is known. False means the run cannot say how much is left.
etaMs ​
readonlyetaMs:number|null
Defined in: graphty-element/src/session/runs/types.ts:158
How much longer, in milliseconds, or null when that cannot be projected.
fraction ​
readonlyfraction:number|null
Defined in: graphty-element/src/session/runs/types.ts:156
How far along, from 0 to 1, or null when indeterminate. Never a fabricated number.
message? ​
readonlyoptionalmessage?:string
Defined in: graphty-element/src/session/runs/types.ts:160
A sentence about the current step, when the run has one to offer.
phase ​
readonlyphase:string
Defined in: graphty-element/src/session/runs/types.ts:148
What the run is doing now, in words a progress line can show.
total ​
readonlytotal:number|null
Defined in: graphty-element/src/session/runs/types.ts:154
How many units there are in total, or null when that is not knowable.