Interface Coordinator

ReadonlyreplicaId

start

• start(): Promise<void>

  Begin heartbeating/renewing (idempotent).

  Returns Promise<void>

stop

• stop(): Promise<void>

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

  Returns Promise<void>

reserve

• reserve(key: string): Promise<Ticket>

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

  Parameters

  • key: string

  Returns Promise<Ticket>

acquireTurn

• acquireTurn(ticket: Ticket, opts?: AcquireTurnOptions): Promise<ChatTurn>

  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

  • ticket: Ticket
  • Optionalopts: AcquireTurnOptions

  Returns Promise<ChatTurn>

lead

• lead(name: string, opts?: { signal?: AbortSignal }): Promise<Leadership>

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

  Parameters

  • name: string
  • Optionalopts: { signal?: AbortSignal }

  Returns Promise<Leadership>

tryLead

• tryLead(name: string): Promise<Leadership | null>

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

  Parameters

  • name: string

  Returns Promise<Leadership | null>

on

• on<E extends keyof CoordinatorEvents>(
      event: E,
      listener: (payload: CoordinatorEvents[E]) => void,
  ): () => void

  Subscribe to coordinator events; returns an unsubscribe.

  Type Parameters

  • E extends keyof CoordinatorEvents

  Parameters

  • event: E
  • listener: (payload: CoordinatorEvents[E]) => void

  Returns () => void