firelordjs/dist/batch/index.d.ts

🔥 High Precision Typescript Wrapper for Firestore Web, Providing Unparalleled Type Safe and Dev Experience

import { Firestore, WriteBatch } from '../types';
/**
 * Creates a write batch, used for performing multiple writes as a single
 * atomic operation. The maximum number of writes allowed in a single {@link 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.
 *
 * @param firestore Optional, a reference to the Firestore database.
 * If no value is provided, default Firestore instance is used.
 *
 * @returns A {@link WriteBatch} that can be used to atomically execute multiple
 * writes.
 */
export declare const writeBatch: (firestore?: Firestore) => WriteBatch;