The Firebase JS SDK is now in BETA!
This EAP site is no longer maintained. See the official Firebase Documentation site for the latest documentation and information about the Firebase JS SDK.

Home > @firebase/firestore > / > writeBatch

writeBatch() function

Creates a write batch, used for performing multiple writes as a single atomic operation. The maximum number of writes allowed in a single WriteBatch is 500.

Unlike transactions, write batches are persisted offline and therefore are preferable when you don't need to condition your writes on read data.

Signature:

export declare function writeBatch(firestore: FirebaseFirestore): WriteBatch;

Parameters

Parameter Type Description
firestore FirebaseFirestore

Returns:

WriteBatch

A WriteBatch that can be used to atomically execute multiple writes.