gatelineAPI reference

Class ControlPlaneClient

Thin outbound HTTP client for the three routes runner-api.ts (server) exposes. Every call here is a client-initiated request — this process never listens on a socket (R3, AC3.1).

Index

Constructors

Methods

claim fetchIntents report validate

Constructors

constructor

new ControlPlaneClient(
    baseUrl: string,
    token: string,
    fetchImpl?: (
        input: string | Request | URL,
        init?: RequestInit,
    ) => Promise<Response>,
): ControlPlaneClient
Parameters
- baseUrl: string
- token: string
- fetchImpl: (input: string | Request | URL, init?: RequestInit) => Promise<Response> = fetch
Returns ControlPlaneClient
- Defined in packages/runner-agent/src/agent.ts:71

Methods

claim

claim(key: string): Promise<boolean>
Parameters
- key: string
Returns Promise<boolean>
- Defined in packages/runner-agent/src/agent.ts:108

fetchIntents

fetchIntents(): Promise<{ intents: PendingIntent[]; repoUrl: null | string }>
Returns Promise<{ intents: PendingIntent[]; repoUrl: null | string }>
- Defined in packages/runner-agent/src/agent.ts:102

report

report(key: string, outcome: DispatchOutcome): Promise<boolean>
Parameters
- key: string
- outcome: DispatchOutcome
Returns Promise<boolean>
- Defined in packages/runner-agent/src/agent.ts:119

validate

validate(): Promise<void>
Startup check (scope step 2): confirms the control plane is reachable and the token is accepted before the poll loop starts, rather than discovering a bad token only after the first silently-failing poll.

Returns Promise<void>
- Defined in packages/runner-agent/src/agent.ts:90