Skip to main content

FleetForgeClient

@fleetforge/sdk

@fleetforge/sdk / FleetForgeClient

Class: FleetForgeClient

Defined in: sdk/typescript/src/client.ts:250

FleetForge ConnectRPC client with convenience helpers for common workflows.

Works in Node by default. For browsers, pass a transportFactory produced by @connectrpc/connect-web.

Example​

const client = new FleetForgeClient("https://runtime.example.com", "2", {
  transportFactory: () => createConnectTransport({ baseUrl, useBinaryFormat: true })
});

Constructors​

Constructor​

new FleetForgeClient(baseUrl, httpVersion, options): FleetForgeClient

Defined in: sdk/typescript/src/client.ts:258

Parameters​

baseUrl​

string = "http://127.0.0.1:50051"

httpVersion​

SdkApiVersion = SDK_API_VERSION

options​

FleetForgeClientOptions = {}

Returns​

FleetForgeClient

Methods​

checkGate()​

checkGate(options): Promise<ChangeGateDecision>

Defined in: sdk/typescript/src/client.ts:479

Parameters​

options​

CheckGateOptions

Returns​

Promise<ChangeGateDecision>

createBranchRun()​

createBranchRun(options): Promise<string>

Defined in: sdk/typescript/src/client.ts:376

Parameters​

options​

BranchRunOptions

Returns​

Promise<string>

getRun()​

getRun(runId): Promise<GetRunResponse>

Defined in: sdk/typescript/src/client.ts:367

Parameters​

runId​

string

Returns​

Promise<GetRunResponse>

iterateEvents()​

iterateEvents(options): AsyncIterable<QueryEvent>

Defined in: sdk/typescript/src/client.ts:665

Iterate through events, transparently following pagination tokens until exhausted.

Parameters​

options​

QueryEventsOptions = {}

Returns​

AsyncIterable<QueryEvent>

listGates()​

listGates(changeId, limit): Promise<ChangeGateDecision[]>

Defined in: sdk/typescript/src/client.ts:574

Parameters​

changeId​

string

limit​

number = 5

Returns​

Promise<ChangeGateDecision[]>

patchStep()​

patchStep(options): Promise<PatchStepResponse>

Defined in: sdk/typescript/src/client.ts:592

Parameters​

options​

PatchStepOptions

Returns​

Promise<PatchStepResponse>

queryEvents()​

queryEvents(options): Promise<QueryEventsResponse>

Defined in: sdk/typescript/src/client.ts:616

Query events with normalized date inputs (Date or ISO8601 string).

Parameters​

options​

QueryEventsOptions = {}

Returns​

Promise<QueryEventsResponse>

recordGateFollowup()​

recordGateFollowup(options): Promise<ChangeGateFollowup>

Defined in: sdk/typescript/src/client.ts:537

Parameters​

options​

GateFollowupOptions

Returns​

Promise<ChangeGateFollowup>

replayRun()​

replayRun(options): Promise<ReplayRunResponse>

Defined in: sdk/typescript/src/client.ts:450

Parameters​

options​

ReplayRunOptions

Returns​

Promise<ReplayRunResponse>

resumeRun()​

resumeRun(runId): Promise<ResumeRunResponse>

Defined in: sdk/typescript/src/client.ts:437

Parameters​

runId​

string

Returns​

Promise<ResumeRunResponse>

submitRun()​

submitRun(options): Promise<string>

Defined in: sdk/typescript/src/client.ts:341

Submit a run DAG. Provide exactly one of dagJson or dagPath. dagPath may use the @file: prefix; set baseDir to resolve relative paths.

Parameters​

options​

SubmitOptions

Returns​

Promise<string>

Throws​

Error if neither/both inputs are provided.

subscribeRun()​

subscribeRun(options): AsyncIterable<SubscribeRunMessage>

Defined in: sdk/typescript/src/client.ts:685

Stream tap events for a run. Automatically ACKs offsets; set includeHeartbeats to receive heartbeat frames.

Parameters​

options​

SubscribeRunOptions

Returns​

AsyncIterable<SubscribeRunMessage>

tapRun()​

tapRun(runId): AsyncIterable<SubscribeRunResponse>

Defined in: sdk/typescript/src/client.ts:801

Parameters​

runId​

string

Returns​

AsyncIterable<SubscribeRunResponse>

updateBreakpoints()​

updateBreakpoints(options): Promise<UpdateBreakpointsResponse>

Defined in: sdk/typescript/src/client.ts:418

Parameters​

options​

UpdateBreakpointsOptions

Returns​

Promise<UpdateBreakpointsResponse>