Home > @firebase/firestore > / > 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.

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 (note that it won't resolve while you're offline).