Home > @firebase/firestore > lite > updateDoc

updateDoc() function

Updates fields in the document referred to by the specified DocumentReference The update will fail if applied to a document that does not exist.

Nested fields can be updated by providing dot-separated field path strings or by providing FieldPath objects.

The result of this update will only be reflected in document reads that occur after the returned Promise resolves. If the client is offline, the update fails. If you would like to see local modifications or buffer writes until the client is online, use the full Firestore SDK.

Signature:

export declare function updateDoc(reference: DocumentReference<unknown>, field: string | FieldPath, value: unknown, ...moreFieldsAndValues: unknown[]): Promise<void>;

Parameters

Parameter	Type	Description
reference	DocumentReference<unknown>	A reference to the document to update.
field	string | FieldPath	The first field to update.
value	unknown	The first value.
moreFieldsAndValues	unknown[]	Additional key value pairs.

Returns:

Promise<void>

A Promise resolved once the data has been successfully written to the backend.