Interface ProgressStep<T>

One step in a OperationProgress.steps run.

interface ProgressStep<T = void> {
    label: string;
    run: (signal: AbortSignal) => T | Promise<T>;
    weight?: number;
}

Type Parameters

T = void

Index

Properties

label run weight?

Properties

`Readonly`label

label: string

Shown while this step runs.

`Readonly`run

run: (signal: AbortSignal) => T | Promise<T>

The work. Receives the combined signal, like any other operation work.

`Optional` `Readonly`weight

weight?: number

How much of the bar this step accounts for, relative to the others.

Default Value