net: add net.BlockList.isBlockList(value)

PR-URL: #56078 Reviewed-By: Yagiz Nizipli <[email protected]> Reviewed-By: theanarkh <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Matteo Collina <[email protected]> Reviewed-By: Chemi Atlow <[email protected]>
nodejs · Dec 18, 2024 · 92a6c56 · 92a6c56
1 parent f97ecef
commit 92a6c56
Show file tree

Hide file tree

Showing 3 changed files with 23 additions and 0 deletions.
diff --git a/doc/api/net.md b/doc/api/net.md
@@ -170,6 +170,15 @@ added:
 
 The list of rules added to the blocklist.
 
+### `BlockList.isBlockList(value)`
+
+<!-- YAML
+added: REPLACEME
+-->
+
+* `value` {any} Any JS value
+* Returns `true` if the `value` is a `net.BlockList`.
+
 ## Class: `net.SocketAddress`
 
 <!-- YAML

diff --git a/lib/internal/blocklist.js b/lib/internal/blocklist.js
@@ -43,6 +43,15 @@ class BlockList {
     this[kHandle][owner_symbol] = this;
   }
 
+  /**
+   * Returns true if the value is a BlockList
+   * @param {any} value
+   * @returns {boolean}
+   */
+  static isBlockList(value) {
+    return value?.[kHandle] !== undefined;
+  }
+
   [kInspect](depth, options) {
     if (depth < 0)
       return this;

diff --git a/test/parallel/test-blocklist.js b/test/parallel/test-blocklist.js
@@ -282,3 +282,8 @@ const util = require('util');
   assert(!blocklist.check('1.1.1.2'));
   assert(!blocklist.check('2.3.4.5'));
 }
+
+{
+  assert(BlockList.isBlockList(new BlockList()));
+  assert(!BlockList.isBlockList({}));
+}