Skip to content
Singapore

Payloads

Type Parameters

Section titled “Type Parameters”

E

Section titled “E”

E extends EditEnvelope

Properties

Section titled “Properties”

CONFIRM

Section titled “CONFIRM”

CONFIRM: object

authority

Section titled “authority”

readonly authority: Authority

records

Section titled “records”

readonly records: readonly Confirmation<E>[]

ELECTION_OFFER

Section titled “ELECTION_OFFER”

ELECTION_OFFER: Offer

HANDOFF

Section titled “HANDOFF”

HANDOFF: object

authority

Section titled “authority”

readonly authority: Authority

branch

Section titled “branch”

readonly branch: Branch

pending

Section titled “pending”

readonly pending: readonly E[]

stage

Section titled “stage”

readonly stage: "prepare" | "commit"

successor

Section titled “successor”

readonly successor: string

HAVE

Section titled “HAVE”

HAVE: object & { handoffStage?: undefined; pending?: undefined; } | { handoffStage: "prepare" | "commit"; pending: readonly EditId[]; }

Type Declaration

Section titled “Type Declaration”
epoch
Section titled “epoch”

readonly epoch: string

tip
Section titled “tip”

readonly tip: Checkpoint

HELLO

Section titled “HELLO”

HELLO: object

branch

Section titled “branch”

readonly branch: Branch

handoff?

Section titled “handoff?”

readonly optional handoff?: object

handoff.authority
Section titled “handoff.authority”

readonly authority: Authority

handoff.branch
Section titled “handoff.branch”

readonly branch: Branch

handoff.pending
Section titled “handoff.pending”

readonly pending: readonly E[]

handoff.stage
Section titled “handoff.stage”

readonly stage: "prepare" | "commit"

handoff.successor
Section titled “handoff.successor”

readonly successor: string

members

Section titled “members”

readonly members: readonly string[]

term

Section titled “term”

readonly term: number

HISTORY_CHUNK

Section titled “HISTORY_CHUNK”

HISTORY_CHUNK: object

count

Section titled “count”

readonly count: number

from

Section titled “from”

readonly from: Checkpoint

index

Section titled “index”

readonly index: number

records

Section titled “records”

readonly records: readonly Confirmation<E>[]

tip

Section titled “tip”

readonly tip: Checkpoint

HISTORY_REQUEST

Section titled “HISTORY_REQUEST”

HISTORY_REQUEST: object

from

Section titled “from”

readonly from: Checkpoint

index

Section titled “index”

readonly index: number

tip

Section titled “tip”

readonly tip: Checkpoint

HOST_CLAIM

Section titled “HOST_CLAIM”

HOST_CLAIM: Commit<E>

HOST_PULSE

Section titled “HOST_PULSE”

HOST_PULSE: object

branch

Section titled “branch”

readonly branch: Branch

handoff?

Section titled “handoff?”

readonly optional handoff?: object

handoff.authority
Section titled “handoff.authority”

readonly authority: Authority

handoff.branch
Section titled “handoff.branch”

readonly branch: Branch

handoff.pending
Section titled “handoff.pending”

readonly pending: readonly E[]

handoff.stage
Section titled “handoff.stage”

readonly stage: "prepare" | "commit"

handoff.successor
Section titled “handoff.successor”

readonly successor: string

members

Section titled “members”

readonly members: readonly string[]

LEAVE

Section titled “LEAVE”

LEAVE: object

successor

Section titled “successor”

readonly successor: string | null

PRESENCE

Section titled “PRESENCE”

PRESENCE: object

clock

Section titled “clock”

readonly clock: number

state

Section titled “state”

readonly state: unknown

RECONCILE_COMMIT

Section titled “RECONCILE_COMMIT”

RECONCILE_COMMIT: Commit<E>

RECONCILE_OFFER

Section titled “RECONCILE_OFFER”

RECONCILE_OFFER: Offer

SUBMIT

Section titled “SUBMIT”

SUBMIT: object

authority

Section titled “authority”

readonly authority: Authority

edits

Section titled “edits”

readonly edits: readonly E[]