gatelineAPI reference

Interface EngineLike

The engine surface runLoop actually drives, narrowed from the concrete Engine class (which the CLI and gateline up pass in) so tests can supply a fake without fighting Engine's private fields — an object literal can't structurally satisfy a class type carrying private state, but a real Engine instance satisfies this interface trivially.

interface EngineLike {
    onSettled: null | () => void;
    deferrals(): Deferral[];
    drain(): Promise<void>;
    inFlight(): number;
    pushHealth(): ReadonlyMap<string, number>;
    syncFromRemote(): Promise<void>;
    tick(): Promise<TickOutcome[]>;
}

Index

Properties

Methods

deferrals? drain inFlight pushHealth syncFromRemote tick

Properties

onSettled

onSettled: null | () => void

Methods

`Optional`deferrals

deferrals(): Deferral[]
Runs held back on the last pass and why (#97); optional for older engines and test doubles.

Returns Deferral[]
- Defined in packages/orchestrator/src/triggers.ts:25

drain

drain(): Promise<void>
Returns Promise<void>
- Defined in packages/orchestrator/src/triggers.ts:26

inFlight

inFlight(): number
Returns number
- Defined in packages/orchestrator/src/triggers.ts:22

pushHealth

pushHealth(): ReadonlyMap<string, number>
Returns ReadonlyMap<string, number>
- Defined in packages/orchestrator/src/triggers.ts:23

syncFromRemote

syncFromRemote(): Promise<void>
Returns Promise<void>
- Defined in packages/orchestrator/src/triggers.ts:21

tick

tick(): Promise<TickOutcome[]>
Returns Promise<TickOutcome[]>
- Defined in packages/orchestrator/src/triggers.ts:20