Skip to content

Commit 0515d1f

Browse files
author
Brian Chen
authored
docs: update BulkWriterError documentation (#1518)
1 parent 92ea651 commit 0515d1f

File tree

1 file changed

+18
-1
lines changed

1 file changed

+18
-1
lines changed

dev/src/index.ts

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -229,7 +229,7 @@ const MAX_CONCURRENT_REQUESTS_PER_CLIENT = 100;
229229
* [update()]{@link DocumentReference#update} and
230230
* [delete()]{@link DocumentReference#delete} calls in
231231
* [DocumentReference]{@link DocumentReference},
232-
* [WriteBatch]{@link WriteBatch}, [BulkWriter]({@link BulkWriter}, and
232+
* [WriteBatch]{@link WriteBatch}, [BulkWriter]{@link BulkWriter}, and
233233
* [Transaction]{@link Transaction}. Using Preconditions, these calls
234234
* can be restricted to only apply to documents that match the specified
235235
* conditions.
@@ -305,6 +305,23 @@ const MAX_CONCURRENT_REQUESTS_PER_CLIENT = 100;
305305
* @typedef {Object} BulkWriterOptions
306306
*/
307307

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+
308325
/**
309326
* Status codes returned by GRPC operations.
310327
*

0 commit comments

Comments
 (0)