Interface RealtimeCheckpointStoreHandle

A checkpoint store plus the record administration a host needs to audit or reset it.

interface RealtimeCheckpointStoreHandle {
    clear(): Promise<void>;
    load(
        context: RealtimeResumeContextV1,
        signal: AbortSignal,
    ): Promise<RealtimeDurableCheckpointV1 | undefined>;
    records(): Promise<readonly RealtimeCheckpointRecordV1[]>;
    save(
        checkpoint: RealtimeDurableCheckpointV1,
        signal: AbortSignal,
    ): Promise<void>;
}

Hierarchy (View Summary)

RealtimeCheckpointStore
- RealtimeCheckpointStoreHandle

Index

Methods

clear load records save

Methods

clear

clear(): Promise<void>
Drop every stored checkpoint, for sign-out and scope teardown.

Returns Promise<void>
- Defined in work/honua-sdk-js/honua-sdk-js/src/realtime/checkpoint-store.ts:229

load

load(
context: RealtimeResumeContextV1,
signal: AbortSignal,
): Promise<RealtimeDurableCheckpointV1 | undefined>
Parameters
- context: RealtimeResumeContextV1
- signal: AbortSignal
Returns Promise<RealtimeDurableCheckpointV1 | undefined>
Inherited from RealtimeCheckpointStore.load
- Defined in work/honua-sdk-js/honua-sdk-js/src/realtime/resumable.ts:118

records

records(): Promise<readonly RealtimeCheckpointRecordV1[]>
Every valid persisted record, for enumeration in tests and diagnostics.

Returns Promise<readonly RealtimeCheckpointRecordV1[]>
- Defined in work/honua-sdk-js/honua-sdk-js/src/realtime/checkpoint-store.ts:227

save

save(
checkpoint: RealtimeDurableCheckpointV1,
signal: AbortSignal,
): Promise<void>
Parameters
- checkpoint: RealtimeDurableCheckpointV1
- signal: AbortSignal
Returns Promise<void>
Inherited from RealtimeCheckpointStore.save
- Defined in work/honua-sdk-js/honua-sdk-js/src/realtime/resumable.ts:119