Interface OperationRun<R>

The handle one run reports through. Both calls are void once the run is not current.

interface OperationRun<R extends object = NoOperationColumn> {
land(refusal?: Refusal, report?: R): void;
progress(fraction: number): void;
}

Type Parameters

R extends object = NoOperationColumn
the declared report shape — what this operation's landing tells the caller

Index

Methods

Methods

land

land(refusal?: Refusal, report?: R): void
Land this run: clean, or with the coded reason it failed, and with the run's structured result where the operation declares one. Lands at most once.

A refusal and a report are not alternatives. A paste that landed six parts and refused two is a run that both succeeded and refused, and flattening that into one of the two is exactly the ambiguous answer the house forbids.
Parameters
- Optionalrefusal: Refusal
- Optionalreport: R
Returns void

progress

progress(fraction: number): void
Progress of this run, clamped into [0, 1]. Dropped once landed or cancelled.
Parameters
- fraction: number
Returns void