gatelineAPI reference

Interface CodeTreeStatus

interface CodeTreeStatus {
    cause?: CodeTreeCause;
    codeHead: string;
    reason?: string;
    startHead: string;
    state: CodeTreeState;
    upgradeBlocked?: boolean;
}

Properties

cause? codeHead reason? startHead state upgradeBlocked?

Properties

Optionalcause

cause?: CodeTreeCause

The machine-readable cause, set only when state === 'paused'.

codeHead

codeHead: string

The code tree's on-disk HEAD as of this check.

Optionalreason

reason?: string

Human-readable cause, set only when state === 'paused'. Names the dirty paths when the cause is dirty.

startHead

startHead: string

The commit the process started on (immutable for the monitor's life).

state

state: CodeTreeState

OptionalupgradeBlocked

upgradeBlocked?: boolean

Set only when paused for a dirty tree whose HEAD is a clean fast-forward of startHead on the default branch: the dirt short-circuits the check before supersede can be evaluated, so an upgrade is queued behind it and the operator should hear both facts together (#222).

Settings

Member Visibility

On This Page

Properties