Skip to main content

Interface: CallGroups<P>

Defined in: packages/orchestration/src/calls/call-groups.ts:101

Type Parameters​

P​

P = unknown

Methods​

dispatchPending()​

dispatchPending(groupId, options?): Promise<DispatchReport>

Defined in: packages/orchestration/src/calls/call-groups.ts:104

Dispatch a group's pending calls, page by page.

Parameters​

groupId​

string

options?​
limit?​

number

Returns​

Promise<DispatchReport>


list()​

list(query): Promise<CallGroup[]>

Defined in: packages/orchestration/src/calls/call-groups.ts:116

A coordinator's groups, newest first. Empty when the tables are missing.

Parameters​

query​
coordinator​

string

groupIds?​

readonly string[]

limit?​

number

requestId?​

string

Returns​

Promise<CallGroup[]>


read()​

read(groupId, page?): Promise<CallGroupRead<P> | null>

Defined in: packages/orchestration/src/calls/call-groups.ts:114

A group, its counts and a page of its calls. Null when it is missing — or when the tables are.

Parameters​

groupId​

string

page?​
afterOrdinal?​

number

limit?​

number

Returns​

Promise<CallGroupRead<P> | null>


returnIfDue()​

returnIfDue(groupId): Promise<CallReturnResult>

Defined in: packages/orchestration/src/calls/call-groups.ts:110

Return the group to its coordinator if a return is due — exactly once per return.

Parameters​

groupId​

string

Returns​

Promise<CallReturnResult>


send()​

send(input): Promise<SendCallsResult>

Defined in: packages/orchestration/src/calls/call-groups.ts:102

Parameters​

input​

SendCallsInput<P>

Returns​

Promise<SendCallsResult>


settle()​

settle(callId): Promise<{ returned?: CallReturnResult; settled: boolean; }>

Defined in: packages/orchestration/src/calls/call-groups.ts:106

Re-derive one call from its chain, stamp its outcome once, and return the group if that made it due.

Parameters​

callId​

string

Returns​

Promise<{ returned?: CallReturnResult; settled: boolean; }>


settleForTicket()​

settleForTicket(ticketId): Promise<{ returned?: CallReturnResult; settled: boolean; }>

Defined in: packages/orchestration/src/calls/call-groups.ts:108

The host's ticket-ended hook. One indexed read for a ticket no call started.

Parameters​

ticketId​

string

Returns​

Promise<{ returned?: CallReturnResult; settled: boolean; }>


sweep()​

sweep(options?): Promise<{ closed: number; dispatched: number; returned: number; settled: number; }>

Defined in: packages/orchestration/src/calls/call-groups.ts:112

The cron's half. Bounded, paged, rotating: a row that fails every time moves to the back.

Parameters​

options?​
limit?​

number

now?​

number

Returns​

Promise<{ closed: number; dispatched: number; returned: number; settled: number; }>