js-bao-wss-client / DocumentSnapshotRequest
Type Alias: DocumentSnapshotRequest
DocumentSnapshotRequest = {
buildId:string;nextEpoch:number;sealedEpoch:number; } | {coveringBuildId:string|null;reason:"empty";sealed:false; }
What asking for a snapshot answered.
Two shapes, because there are two outcomes worth telling apart: the open epoch was sealed and a build is on its way, or it carried nothing and there was nothing to seal — in which case the base named by coveringBuildId already describes the document.
Union Members
Type Literal
{ buildId: string; nextEpoch: number; sealedEpoch: number; }
buildId
buildId:
string
The build the seal armed; get describes it once it starts.
nextEpoch
nextEpoch:
number
The epoch the document is writing to now.
sealedEpoch
sealedEpoch:
number
The epoch that was sealed.
Type Literal
{ coveringBuildId: string | null; reason: "empty"; sealed: false; }
coveringBuildId
coveringBuildId:
string|null
The completed base that already covers the document, if any.
reason
reason:
"empty"
sealed
sealed:
false