Interface Write

A write operation

interface Write {
    currentDocument?: Precondition;
    delete?: string;
    transform?: DocumentTransform;
    update?: FirestoreDocument;
    updateMask?: { fieldPaths: string[] };
    updateTransforms?: FieldTransform[];
}

Index

Properties

currentDocument? delete? transform? update? updateMask? updateTransforms?

Properties

`Optional`currentDocument

currentDocument?: Precondition

Precondition for this write

`Optional`delete

delete?: string

A document to delete

`Optional`transform

transform?: DocumentTransform

A document transformation

`Optional`update

update?: FirestoreDocument

A document to write (set)

`Optional`updateMask

updateMask?: { fieldPaths: string[] }

Fields to update (for partial updates)

`Optional`updateTransforms

updateTransforms?: FieldTransform[]

Transforms to apply after update