docs(NODE-3481): deprecate unref (#2936)

mongodb · Aug 12, 2021 · cc0cc20 · cc0cc20
1 parent fbdc7c8
commit cc0cc20
Show file tree

Hide file tree

Showing 4 changed files with 7 additions and 1 deletion.
diff --git a/lib/core/connection/connection.js b/lib/core/connection/connection.js
@@ -190,6 +190,7 @@ class Connection extends EventEmitter {
    * Unref this connection
    * @method
    * @return {boolean}
+   * @deprecated This function is deprecated and will be removed in the next major version.
    */
   unref() {
     if (this.socket == null) {

diff --git a/lib/core/connection/pool.js b/lib/core/connection/pool.js
@@ -604,6 +604,7 @@ Pool.prototype.logout = function(dbName, callback) {
 /**
  * Unref the pool
  * @method
+ * @deprecated This function is deprecated and will be removed in the next major version.
  */
 Pool.prototype.unref = function() {
   // Get all the known connections

diff --git a/lib/core/sdam/topology.js b/lib/core/sdam/topology.js
@@ -742,8 +742,11 @@ class Topology extends EventEmitter {
     return this.s.state === STATE_CLOSED;
   }
 
+  /**
+   * @deprecated This function is deprecated and will be removed in the next major version.
+   */
   unref() {
-    emitWarning('not implemented: `unref`');
+    emitWarning('`unref` is a noop and will be removed in the next major version');
   }
 
   // NOTE: There are many places in code where we explicitly check the last isMaster

diff --git a/lib/db.js b/lib/db.js
@@ -951,6 +951,7 @@ Db.prototype.indexInformation = function(name, options, callback) {
 /**
  * Unref all sockets
  * @method
+ * @deprecated This function is deprecated and will be removed in the next major version.
  */
 Db.prototype.unref = function() {
   this.s.topology.unref();