Skip to main content
Version: v1

IPendingRuntimeState Interface

State saved when the container closes, to be given back to a newly instantiated runtime in a new instance of the container, so it can load to the same state

Signature

export interface IPendingRuntimeState

Properties

Property Modifiers Type Description
baseSnapshot ISnapshotTree A base snapshot at a sequence number prior to the first pending op
pending optional IPendingLocalState Pending ops from PendingStateManager
savedOps ISequencedDocumentMessage[] All runtime ops since base snapshot sequence number up to the latest op seen when the container was closed. Used to apply stashed (saved pending) ops at the same sequence number at which they were made.
snapshotBlobs ISerializedBaseSnapshotBlobs Serialized blobs from the base snapshot. Used to load offline since storage is not available.

Property Details

baseSnapshot

A base snapshot at a sequence number prior to the first pending op

Signature

baseSnapshot: ISnapshotTree;

Type: ISnapshotTree

pending

Pending ops from PendingStateManager

Signature

pending?: IPendingLocalState;

Type: IPendingLocalState

savedOps

All runtime ops since base snapshot sequence number up to the latest op seen when the container was closed. Used to apply stashed (saved pending) ops at the same sequence number at which they were made.

Signature

savedOps: ISequencedDocumentMessage[];

Type: ISequencedDocumentMessage[]

snapshotBlobs

Serialized blobs from the base snapshot. Used to load offline since storage is not available.

Signature

snapshotBlobs: ISerializedBaseSnapshotBlobs;

Type: ISerializedBaseSnapshotBlobs