@@ -229,7 +229,7 @@ const MAX_CONCURRENT_REQUESTS_PER_CLIENT = 100;
229
229
* [update()]{@link DocumentReference#update} and
230
230
* [delete()]{@link DocumentReference#delete} calls in
231
231
* [DocumentReference]{@link DocumentReference},
232
- * [WriteBatch]{@link WriteBatch}, [BulkWriter]( {@link BulkWriter}, and
232
+ * [WriteBatch]{@link WriteBatch}, [BulkWriter]{@link BulkWriter}, and
233
233
* [Transaction]{@link Transaction}. Using Preconditions, these calls
234
234
* can be restricted to only apply to documents that match the specified
235
235
* conditions.
@@ -305,6 +305,23 @@ const MAX_CONCURRENT_REQUESTS_PER_CLIENT = 100;
305
305
* @typedef {Object } BulkWriterOptions
306
306
*/
307
307
308
+ /**
309
+ * An error thrown when a BulkWriter operation fails.
310
+ *
311
+ * The error used by {@link BulkWriter~shouldRetryCallback} set in
312
+ * {@link BulkWriter#onWriteError}.
313
+ *
314
+ * @property {GrpcStatus } code The status code of the error.
315
+ * @property {string } message The error message of the error.
316
+ * @property {DocumentReference } documentRef The document reference the operation was
317
+ * performed on.
318
+ * @property {'create' | 'set' | 'update' | 'delete' } operationType The type
319
+ * of operation performed.
320
+ * @property {number } failedAttempts How many times this operation has been
321
+ * attempted unsuccessfully.
322
+ * @typedef {Error } BulkWriterError
323
+ */
324
+
308
325
/**
309
326
* Status codes returned by GRPC operations.
310
327
*
0 commit comments