Interface CreateResumableRealtimeSubscriptionOptions<TFeature>

interface CreateResumableRealtimeSubscriptionOptions<TFeature = unknown> {
    apply: (
        event: RealtimeSequencedEvent<TFeature>,
        signal: AbortSignal,
    ) => void | Promise<void>;
    checkpointStore?: RealtimeCheckpointStore;
    context: RealtimeResumeContextV1;
    initialCheckpoint?: RealtimeDurableCheckpointV1;
    maxPendingEvents?: number;
    maxRecentEventIds?: number;
    now?: () => number;
    signal?: AbortSignal;
}

Type Parameters

TFeature = unknown

Index

Properties

apply checkpointStore? context initialCheckpoint? maxPendingEvents? maxRecentEventIds? now? signal?

Properties

`Readonly`apply

apply: (
event: RealtimeSequencedEvent<TFeature>,
signal: AbortSignal,
) => void | Promise<void>

`Optional` `Readonly`checkpointStore

checkpointStore?: RealtimeCheckpointStore

`Readonly`context

context: RealtimeResumeContextV1

`Optional` `Readonly`initialCheckpoint

initialCheckpoint?: RealtimeDurableCheckpointV1

Takes precedence over checkpointStore.load when supplied.

`Optional` `Readonly`maxPendingEvents

maxPendingEvents?: number

Includes the currently applying event.

Default

`Optional` `Readonly`maxRecentEventIds

maxRecentEventIds?: number

Bounded event-id history persisted with each checkpoint.

Default

`Optional` `Readonly`now

now?: () => number

`Optional` `Readonly`signal

signal?: AbortSignal