Coordinator

Interface exported by @botmesh/core.

Defined in: coordination/types.ts:164

Cross-replica coordination backend. One instance per replica (per Bot); the bot calls start when it starts and stop when it stops.

Properties

replicaId

readonly replicaId: string;

Defined in: coordination/types.ts:166

This replica’s id; unique among the replicas sharing the backend.

Methods

start()

start(): Promise<void>;

Defined in: coordination/types.ts:168

Begin heartbeating/renewing (idempotent).

Returns

Promise<void>

---

stop()

stop(): Promise<void>;

Defined in: coordination/types.ts:170

Release every turn and leadership this replica holds and stop renewing (idempotent).

Returns

Promise<void>

---

reserve()

reserve(key): Promise<Ticket>;

Defined in: coordination/types.ts:172

Reserve a place in key’s cross-replica FIFO. The bot calls it in ingress order.

Parameters

Parameter	Type
key	string

Returns

Promise<Ticket>

---

acquireTurn()

acquireTurn(ticket, opts?): Promise<ChatTurn>;

Defined in: coordination/types.ts:179

Wait until it is ticket’s turn (tickets of replicas that died are skipped), then hold the key. Rejects with LeaseLostError ('superseded') when the ticket was skipped because this replica was presumed dead, and with CoordinationUnavailableError on timeout or backend failure.

Parameters

Parameter	Type
ticket	Ticket
opts?	AcquireTurnOptions

Returns

Promise<ChatTurn>

---

lead()

lead(name, opts?): Promise<Leadership>;

Defined in: coordination/types.ts:181

Campaign for name until elected (or opts.signal aborts, rejecting).

Parameters

Parameter	Type
name	string
opts?	{ signal?: AbortSignal; }
opts.signal?	AbortSignal

Returns

Promise<Leadership>

---

tryLead()

tryLead(name): Promise<Leadership | null>;

Defined in: coordination/types.ts:183

One election attempt: the leadership, or null when another replica leads.

Parameters

Parameter	Type
name	string

Returns

Promise<Leadership | null>

---

on()

on<E>(event, listener): () => void;

Defined in: coordination/types.ts:185

Subscribe to coordinator events; returns an unsubscribe.

Type Parameters

Type Parameter
E extends keyof CoordinatorEvents

Parameters

Parameter	Type
event	E
listener	(payload) => void

Returns

() => void