Type Alias StructuredWriteContext

Optional context supplied with a structured document write.

type StructuredWriteContext = {
    deleted?: boolean;
    expectedVersion?: number;
    occupancyFields?: StructuredOccupancyFieldMap;
}

Properties

deleted?: boolean

True when this write removes the document rather than storing {}.

expectedVersion?: number

Optional structured-document version that must still be current.

Maintenance callers use this to avoid deleting index state that changed after it was audited.

All eligible scalar fields for the document type, including missing ones.