emphasize deprecation

mongodb · Nov 17, 2020 · abdefbe · abdefbe
1 parent 7e79b7f
commit abdefbe
Show file tree

Hide file tree

Showing 6 changed files with 143 additions and 108 deletions.
diff --git a/lib/admin.js b/lib/admin.js
@@ -166,10 +166,11 @@ Admin.prototype.ping = function(options, callback) {
  * @param {string} username The username.
  * @param {string} password The password.
  * @param {object} [options] Optional settings.
- * @param {(number|string)} [options.w] The write concern.
- * @param {number} [options.wtimeout] The write concern timeout.
- * @param {boolean} [options.j=false] Specify a journal write concern.
- * @param {boolean} [options.fsync=false] Specify a file sync write concern.
+ * @param {(number|string)} [options.w] DEPRECATED: The write concern. Use writeConcern instead.
+ * @param {number} [options.wtimeout] DEPRECATED: The write concern timeout. Use writeConcern instead.
+ * @param {boolean} [options.j=false] DEPRECATED: Specify a journal write concern. Use writeConcern instead.
+ * @param {boolean} [options.fsync=false] DEPRECATED: Specify a file sync write concern. Use writeConcern instead.
+ * @param {object|WriteConcern} [options.writeConcern] Specify write concern settings.
  * @param {object} [options.customData] Custom data associated with the user (only Mongodb 2.6 or higher)
  * @param {object[]} [options.roles] Roles associated with the created user (only Mongodb 2.6 or higher)
  * @param {ClientSession} [options.session] optional session to use for this operation
@@ -203,10 +204,11 @@ Admin.prototype.addUser = function(username, password, options, callback) {
  * @method
  * @param {string} username The username.
  * @param {object} [options] Optional settings.
- * @param {(number|string)} [options.w] The write concern.
- * @param {number} [options.wtimeout] The write concern timeout.
- * @param {boolean} [options.j=false] Specify a journal write concern.
- * @param {boolean} [options.fsync=false] Specify a file sync write concern.
+ * @param {(number|string)} [options.w] DEPRECATED: The write concern. Use writeConcern instead.
+ * @param {number} [options.wtimeout] DEPRECATED: The write concern timeout. Use writeConcern instead.
+ * @param {boolean} [options.j=false] DEPRECATED: Specify a journal write concern. Use writeConcern instead.
+ * @param {boolean} [options.fsync=false] DEPRECATED: Specify a file sync write concern. Use writeConcern instead.
+ * @param {object|WriteConcern} [options.writeConcern] Specify write concern settings.
  * @param {ClientSession} [options.session] optional session to use for this operation
  * @param {Admin~resultCallback} [callback] The command result callback
  * @return {Promise} returns Promise if no callback passed

diff --git a/lib/bulk/common.js b/lib/bulk/common.js
@@ -1125,10 +1125,11 @@ class BulkOperationBase {
    * @method
    * @param {WriteConcern} [_writeConcern] Optional write concern. Can also be specified through options.
    * @param {object} [options] Optional settings.
-   * @param {(number|string)} [options.w] The write concern.
-   * @param {number} [options.wtimeout] The write concern timeout.
-   * @param {boolean} [options.j=false] Specify a journal write concern.
-   * @param {boolean} [options.fsync=false] Specify a file sync write concern.
+   * @param {(number|string)} [options.w] DEPRECATED: The write concern. Use writeConcern instead.
+   * @param {number} [options.wtimeout] DEPRECATED: The write concern timeout. Use writeConcern instead.
+   * @param {boolean} [options.j=false] DEPRECATED: Specify a journal write concern. Use writeConcern instead.
+   * @param {boolean} [options.fsync=false] DEPRECATED: Specify a file sync write concern. Use writeConcern instead.
+   * @param {object|WriteConcern} [options.writeConcern] Specify write concern settings.
    * @param {BulkOperationBase~resultCallback} [callback] A callback that will be invoked when bulkWrite finishes/errors
    * @throws {MongoError} Throws error if the bulk object has already been executed
    * @throws {MongoError} Throws error if the bulk object does not have any operations