Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More →
@google-cloud/firestore
Advanced tools
@google-cloud/firestore - npm Package Compare versions
Comparing version 4.11.1 to 4.12.0
@@ -295,7 +295,16 @@ /*! | ||
| /** | ||
| * Callback function set by {@link BulkWriter#onWriteResult} that is run | ||
| * every time a {@link BulkWriter} operation successfully completes. | ||
| * | ||
| * @callback BulkWriter~successCallback | ||
| * @param {DocumentReference} documentRef The document reference the | ||
| * operation was performed on | ||
| * @param {WriteResult} result The server write time of the operation. | ||
| */ | ||
| /** | ||
| * Attaches a listener that is run every time a BulkWriter operation | ||
| * successfully completes. | ||
| * | ||
| * @param callback A callback to be called every time a BulkWriter operation | ||
| * successfully completes. | ||
| * @param {BulkWriter~successCallback} successCallback A callback to be | ||
| * called every time a BulkWriter operation successfully completes. | ||
| * @example | ||
@@ -314,4 +323,15 @@ * let bulkWriter = firestore.bulkWriter(); | ||
| */ | ||
| onWriteResult(callback: (documentRef: firestore.DocumentReference<unknown>, result: WriteResult) => void): void; | ||
| onWriteResult(successCallback: (documentRef: firestore.DocumentReference<unknown>, result: WriteResult) => void): void; | ||
| /** | ||
| * Callback function set by {@link BulkWriter#onWriteError} that is run when | ||
| * a write fails in order to determine whether {@link BulkWriter} should | ||
| * retry the operation. | ||
| * | ||
| * @callback BulkWriter~shouldRetryCallback | ||
| * @param {BulkWriterError} error The error object with information about the | ||
| * operation and error. | ||
| * @returns {boolean} Whether or not to retry the failed operation. Returning | ||
| * `true` retries the operation. Returning `false` will stop the retry loop. | ||
| */ | ||
| /** | ||
| * Attaches an error handler listener that is run every time a BulkWriter | ||
@@ -324,5 +344,5 @@ * operation fails. | ||
| * | ||
| * @param shouldRetryCallback A callback to be called every time a BulkWriter | ||
| * operation fails. Returning `true` will retry the operation. Returning | ||
| * `false` will stop the retry loop. | ||
| * @param shouldRetryCallback {BulkWriter~shouldRetryCallback} A callback to | ||
| * be called every time a BulkWriter operation fails. Returning `true` will | ||
| * retry the operation. Returning `false` will stop the retry loop. | ||
| * @example | ||
@@ -412,2 +432,3 @@ * let bulkWriter = firestore.bulkWriter(); | ||
| * Sends the provided batch once the rate limiter does not require any delay. | ||
| * @private | ||
| */ | ||
@@ -414,0 +435,0 @@ private _sendBatch; |
@@ -479,7 +479,16 @@ "use strict"; | ||
| /** | ||
| * Callback function set by {@link BulkWriter#onWriteResult} that is run | ||
| * every time a {@link BulkWriter} operation successfully completes. | ||
| * | ||
| * @callback BulkWriter~successCallback | ||
| * @param {DocumentReference} documentRef The document reference the | ||
| * operation was performed on | ||
| * @param {WriteResult} result The server write time of the operation. | ||
| */ | ||
| /** | ||
| * Attaches a listener that is run every time a BulkWriter operation | ||
| * successfully completes. | ||
| * | ||
| * @param callback A callback to be called every time a BulkWriter operation | ||
| * successfully completes. | ||
| * @param {BulkWriter~successCallback} successCallback A callback to be | ||
| * called every time a BulkWriter operation successfully completes. | ||
| * @example | ||
@@ -498,6 +507,17 @@ * let bulkWriter = firestore.bulkWriter(); | ||
| */ | ||
| onWriteResult(callback) { | ||
| this._successFn = callback; | ||
| onWriteResult(successCallback) { | ||
| this._successFn = successCallback; | ||
| } | ||
| /** | ||
| * Callback function set by {@link BulkWriter#onWriteError} that is run when | ||
| * a write fails in order to determine whether {@link BulkWriter} should | ||
| * retry the operation. | ||
| * | ||
| * @callback BulkWriter~shouldRetryCallback | ||
| * @param {BulkWriterError} error The error object with information about the | ||
| * operation and error. | ||
| * @returns {boolean} Whether or not to retry the failed operation. Returning | ||
| * `true` retries the operation. Returning `false` will stop the retry loop. | ||
| */ | ||
| /** | ||
| * Attaches an error handler listener that is run every time a BulkWriter | ||
@@ -510,5 +530,5 @@ * operation fails. | ||
| * | ||
| * @param shouldRetryCallback A callback to be called every time a BulkWriter | ||
| * operation fails. Returning `true` will retry the operation. Returning | ||
| * `false` will stop the retry loop. | ||
| * @param shouldRetryCallback {BulkWriter~shouldRetryCallback} A callback to | ||
| * be called every time a BulkWriter operation fails. Returning `true` will | ||
| * retry the operation. Returning `false` will stop the retry loop. | ||
| * @example | ||
@@ -630,2 +650,3 @@ * let bulkWriter = firestore.bulkWriter(); | ||
| * Sends the provided batch once the rate limiter does not require any delay. | ||
| * @private | ||
| */ | ||
@@ -632,0 +653,0 @@ async _sendBatch(batch, flush = false) { |
@@ -114,3 +114,3 @@ /*! | ||
| * [DocumentReference]{@link DocumentReference}, | ||
| * [WriteBatch]{@link WriteBatch}, and | ||
| * [WriteBatch]{@link WriteBatch}, [BulkWriter]({@link BulkWriter}, and | ||
| * [Transaction]{@link Transaction}. Using Preconditions, these calls | ||
@@ -133,2 +133,4 @@ * can be restricted to only apply to documents that match the specified | ||
| * operation if the document was last updated at a different time. | ||
| * @property {boolean} exists If set, enforces that the target document must | ||
| * or must not exist. | ||
| * @typedef {Object} Precondition | ||
@@ -135,0 +137,0 @@ */ |
@@ -189,3 +189,3 @@ "use strict"; | ||
| * [DocumentReference]{@link DocumentReference}, | ||
| * [WriteBatch]{@link WriteBatch}, and | ||
| * [WriteBatch]{@link WriteBatch}, [BulkWriter]({@link BulkWriter}, and | ||
| * [Transaction]{@link Transaction}. Using Preconditions, these calls | ||
@@ -208,2 +208,4 @@ * can be restricted to only apply to documents that match the specified | ||
| * operation if the document was last updated at a different time. | ||
| * @property {boolean} exists If set, enforces that the target document must | ||
| * or must not exist. | ||
| * @typedef {Object} Precondition | ||
@@ -210,0 +212,0 @@ */ |
@@ -220,2 +220,4 @@ /*! | ||
| * document was last updated at a different time. | ||
| * @param {boolean=} precondition.exists If set, enforces that the target | ||
| * document must or must not exist. | ||
| * @returns {Promise.<WriteResult>} A Promise that resolves with the | ||
@@ -222,0 +224,0 @@ * delete time. |
@@ -161,2 +161,4 @@ /*! | ||
| * document doesn't exist or was last updated at a different time. | ||
| * @param {boolean=} precondition.exists If set, enforces that the target | ||
| * document must or must not exist. | ||
| * @returns {Transaction} This Transaction instance. Used for | ||
@@ -163,0 +165,0 @@ * chaining method calls. |
@@ -236,2 +236,4 @@ "use strict"; | ||
| * document doesn't exist or was last updated at a different time. | ||
| * @param {boolean=} precondition.exists If set, enforces that the target | ||
| * document must or must not exist. | ||
| * @returns {Transaction} This Transaction instance. Used for | ||
@@ -238,0 +240,0 @@ * chaining method calls. |
@@ -137,2 +137,4 @@ /*! | ||
| * document doesn't exist or was last updated at a different time. | ||
| * @param {boolean= } precondition.exists If set to true, enforces that the target | ||
| * document must or must not exist. | ||
| * @returns {WriteBatch} This WriteBatch instance. Used for chaining | ||
@@ -139,0 +141,0 @@ * method calls. |
@@ -171,2 +171,4 @@ "use strict"; | ||
| * document doesn't exist or was last updated at a different time. | ||
| * @param {boolean= } precondition.exists If set to true, enforces that the target | ||
| * document must or must not exist. | ||
| * @returns {WriteBatch} This WriteBatch instance. Used for chaining | ||
@@ -173,0 +175,0 @@ * method calls. |
@@ -7,2 +7,10 @@ # Changelog | ||
| ## [4.12.0](https://www.github.com/googleapis/nodejs-firestore/compare/v4.11.1...v4.12.0) (2021-05-19) | ||
| ### Features | ||
| * add `gcf-owl-bot[bot]` to `ignoreAuthors` ([#1506](https://www.github.com/googleapis/nodejs-firestore/issues/1506)) ([6fa1d4d](https://www.github.com/googleapis/nodejs-firestore/commit/6fa1d4da627f17d76cf2d6109765862fd5083e03)) | ||
| * add Precondition.exists to delete() ([#1505](https://www.github.com/googleapis/nodejs-firestore/issues/1505)) ([28d645b](https://www.github.com/googleapis/nodejs-firestore/commit/28d645bd3e368abde592bfa2611de3378ca175a6)) | ||
| ### [4.11.1](https://www.github.com/googleapis/nodejs-firestore/compare/v4.11.0...v4.11.1) (2021-05-13) | ||
@@ -9,0 +17,0 @@ |
| { | ||
| "name": "@google-cloud/firestore", | ||
| "description": "Firestore Client Library for Node.js", | ||
| "version": "4.11.1", | ||
| "version": "4.12.0", | ||
| "license": "Apache-2.0", | ||
@@ -6,0 +6,0 @@ "author": "Google Inc.", |
Sorry, the diff of this file is too big to display
Sorry, the diff of this file is too big to display
New alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Fixed alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Improved metrics
- Total package byte prevSize
- increased by0.07%
5483087
- Lines of code
- increased by0.06%
103314
No dependency changes