Interface RealtimeResumableTransportOptions<TFeature>

interface RealtimeResumableTransportOptions<TFeature> {
    checkpointStore?: RealtimeCheckpointStore;
    context: RealtimeResumeContextV1;
    heartbeatTimeoutMs?: number;
    initialCheckpoint?: RealtimeDurableCheckpointV1;
    maxPendingEvents?: number;
    maxRecentEventIds?: number;
    now?: (() => number);
    onTelemetry?: ((telemetry: RealtimeResumableTransportTelemetry) => void);
    reconnect?: RealtimeReconnectPolicy;
    staleAfterMs?: number;
}

Type Parameters

  • TFeature = unknown

Properties

checkpointStore? context heartbeatTimeoutMs? initialCheckpoint? maxPendingEvents? maxRecentEventIds? now? onTelemetry? reconnect? staleAfterMs?

Properties

Optional ReadonlycheckpointStore

checkpointStore?: RealtimeCheckpointStore

Readonlycontext

context: RealtimeResumeContextV1

Optional ReadonlyheartbeatTimeoutMs

heartbeatTimeoutMs?: number

No event (including heartbeats) within this window is treated as a transport-detected gap. Disabled when omitted.

Optional ReadonlyinitialCheckpoint

initialCheckpoint?: RealtimeDurableCheckpointV1

Seed resume position for the very first connection, validated the same way a loaded checkpointStore checkpoint is (evaluateRealtimeCheckpoint). This is the only supported way to seed a resume position: subscribe()'s request.cursor / resumeFrom and similar fields are ignored by this wrapper so a stale or unscoped caller-supplied position can never bypass checkpoint compatibility validation.

Optional ReadonlymaxPendingEvents

maxPendingEvents?: number

Includes the currently applying event.

Default

64

Optional ReadonlymaxRecentEventIds

maxRecentEventIds?: number

Bounded event-id history persisted with each checkpoint.

Default

256

Optional Readonlynow

now?: (() => number)

Optional ReadonlyonTelemetry

onTelemetry?: ((telemetry: RealtimeResumableTransportTelemetry) => void)

Optional Readonlyreconnect

reconnect?: RealtimeReconnectPolicy

Optional ReadonlystaleAfterMs

staleAfterMs?: number

Forwarded to deriveRealtimeContractAuthority for telemetry.

Settings

Member Visibility

On This Page

Properties