gatelineAPI reference

Interface ShutdownTarget

interface ShutdownTarget {
    progressMs?: number;
    abort(): number;
    drain(): Promise<void>;
    exit(code: number): void;
    inFlight(): InFlightJob[];
    log(line: string): void;
}

Index

Properties

Methods

abort drain exit inFlight log

Properties

`Optional`progressMs

progressMs?: number

Interval between "still draining" reports (default 60s).

Methods

abort

abort(): number
SIGKILL live harness groups; closing commits still land.

Returns number
- Defined in packages/orchestrator/src/shutdown.ts:23

drain

drain(): Promise<void>
Stop watching and wait for in-flight dispatches to close.

Returns Promise<void>
- Defined in packages/orchestrator/src/shutdown.ts:21

exit

exit(code: number): void
Injectable for tests; process.exit in production.
Parameters
- code: number
Returns void
- Defined in packages/orchestrator/src/shutdown.ts:26

inFlight

inFlight(): InFlightJob[]
Returns InFlightJob[]
- Defined in packages/orchestrator/src/shutdown.ts:19

log

log(line: string): void
Parameters
- line: string
Returns void
- Defined in packages/orchestrator/src/shutdown.ts:24