@helpers4/node 2.0.1 → 2.0.3

package/README.md

@@ -13,6 +13,8 @@ A set of helpers for working with URLs.
 
 <!-- AUTOMATIC-METHODS -->
 - isBuffer
+- isNodeStream
+- isSharedArrayBuffer
 <!-- /AUTOMATIC-METHODS -->
 
 ## See

package/lib/index.d.ts

@@ -23,4 +23,51 @@
  */
 declare function isBuffer(value: unknown): value is Buffer;
 
-export { isBuffer };
+/**
+ * This file is part of helpers4.
+ * Copyright (C) 2025 baxyz
+ * SPDX-License-Identifier: LGPL-3.0-or-later
+ */
+/**
+ * Checks if a value is a Node.js stream (has a `.pipe()` method).
+ *
+ * Uses duck-typing: any object with a `pipe` function qualifies, covering
+ * `Readable`, `Writable`, `Duplex`, `Transform`, and custom stream-compatible
+ * objects without importing from `node:stream`.
+ *
+ * @param value - The value to check
+ * @returns `true` if value is a Node.js stream
+ * @example
+ * import { Readable } from 'node:stream';
+ * isNodeStream(new Readable()) // => true
+ * isNodeStream({})             // => false
+ * isNodeStream(null)           // => false
+ * @since 2.0.3
+ */
+declare function isNodeStream(value: unknown): value is {
+    pipe: (...args: unknown[]) => unknown;
+};
+
+/**
+ * This file is part of helpers4.
+ * Copyright (C) 2025 baxyz
+ * SPDX-License-Identifier: LGPL-3.0-or-later
+ */
+/**
+ * Checks if a value is a `SharedArrayBuffer` instance.
+ *
+ * `SharedArrayBuffer` enables shared memory between the main thread and worker
+ * threads. In browsers without COOP/COEP headers, `SharedArrayBuffer` may be
+ * unavailable; this function returns `false` in that case.
+ *
+ * @param value - The value to check
+ * @returns `true` if value is a SharedArrayBuffer
+ * @example
+ * isSharedArrayBuffer(new SharedArrayBuffer(8)) // => true
+ * isSharedArrayBuffer(new ArrayBuffer(8))       // => false
+ * isSharedArrayBuffer(null)                     // => false
+ * @since 2.0.3
+ */
+declare function isSharedArrayBuffer(value: unknown): value is SharedArrayBuffer;
+
+export { isBuffer, isNodeStream, isSharedArrayBuffer };

package/lib/index.js

@@ -26,6 +26,57 @@ function isBuffer(value) {
 	return typeof Buffer !== "undefined" && value instanceof Buffer;
 }
 //#endregion
-export { isBuffer };
+//#region helpers/node/isNodeStream.ts
+/**
+* This file is part of helpers4.
+* Copyright (C) 2025 baxyz
+* SPDX-License-Identifier: LGPL-3.0-or-later
+*/
+/**
+* Checks if a value is a Node.js stream (has a `.pipe()` method).
+*
+* Uses duck-typing: any object with a `pipe` function qualifies, covering
+* `Readable`, `Writable`, `Duplex`, `Transform`, and custom stream-compatible
+* objects without importing from `node:stream`.
+*
+* @param value - The value to check
+* @returns `true` if value is a Node.js stream
+* @example
+* import { Readable } from 'node:stream';
+* isNodeStream(new Readable()) // => true
+* isNodeStream({})             // => false
+* isNodeStream(null)           // => false
+* @since 2.0.3
+*/
+function isNodeStream(value) {
+	return value !== null && typeof value === "object" && typeof value["pipe"] === "function";
+}
+//#endregion
+//#region helpers/node/isSharedArrayBuffer.ts
+/**
+* This file is part of helpers4.
+* Copyright (C) 2025 baxyz
+* SPDX-License-Identifier: LGPL-3.0-or-later
+*/
+/**
+* Checks if a value is a `SharedArrayBuffer` instance.
+*
+* `SharedArrayBuffer` enables shared memory between the main thread and worker
+* threads. In browsers without COOP/COEP headers, `SharedArrayBuffer` may be
+* unavailable; this function returns `false` in that case.
+*
+* @param value - The value to check
+* @returns `true` if value is a SharedArrayBuffer
+* @example
+* isSharedArrayBuffer(new SharedArrayBuffer(8)) // => true
+* isSharedArrayBuffer(new ArrayBuffer(8))       // => false
+* isSharedArrayBuffer(null)                     // => false
+* @since 2.0.3
+*/
+function isSharedArrayBuffer(value) {
+	return typeof SharedArrayBuffer !== "undefined" && value instanceof SharedArrayBuffer;
+}
+//#endregion
+export { isBuffer, isNodeStream, isSharedArrayBuffer };
 
 //# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","names":[],"sources":["../../../helpers/node/isBuffer.ts"],"sourcesContent":["/**\n * This file is part of helpers4.\n * Copyright (C) 2025 baxyz\n * SPDX-License-Identifier: LGPL-3.0-or-later\n */\n\n/**\n * Checks if a value is a Node.js Buffer instance.\n *\n * `Buffer` extends `Uint8Array` and is specific to Node.js, Bun, and Deno.\n * In browser-only environments where `Buffer` is not defined, this function\n * always returns `false`.\n *\n * Useful for filtering or type-narrowing in a functional pipeline:\n * `values.filter(isBuffer)`\n *\n * @param value - The value to check\n * @returns True if value is a Buffer\n * @example\n * isBuffer(Buffer.from('hello')) // => true\n * isBuffer(new Uint8Array(8))    // => false\n * isBuffer('hello')              // => false\n * @since 2.0.0\n */\nexport function isBuffer(value: unknown): value is Buffer {\n  return typeof Buffer !== 'undefined' && value instanceof Buffer;\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;AAwBA,SAAgB,SAAS,OAAiC;CACxD,OAAO,OAAO,WAAW,eAAe,iBAAiB;AAC3D"}
+{"version":3,"file":"index.js","names":[],"sources":["../../../helpers/node/isBuffer.ts","../../../helpers/node/isNodeStream.ts","../../../helpers/node/isSharedArrayBuffer.ts"],"sourcesContent":["/**\n * This file is part of helpers4.\n * Copyright (C) 2025 baxyz\n * SPDX-License-Identifier: LGPL-3.0-or-later\n */\n\n/**\n * Checks if a value is a Node.js Buffer instance.\n *\n * `Buffer` extends `Uint8Array` and is specific to Node.js, Bun, and Deno.\n * In browser-only environments where `Buffer` is not defined, this function\n * always returns `false`.\n *\n * Useful for filtering or type-narrowing in a functional pipeline:\n * `values.filter(isBuffer)`\n *\n * @param value - The value to check\n * @returns True if value is a Buffer\n * @example\n * isBuffer(Buffer.from('hello')) // => true\n * isBuffer(new Uint8Array(8))    // => false\n * isBuffer('hello')              // => false\n * @since 2.0.0\n */\nexport function isBuffer(value: unknown): value is Buffer {\n  return typeof Buffer !== 'undefined' && value instanceof Buffer;\n}\n","/**\n * This file is part of helpers4.\n * Copyright (C) 2025 baxyz\n * SPDX-License-Identifier: LGPL-3.0-or-later\n */\n\n/**\n * Checks if a value is a Node.js stream (has a `.pipe()` method).\n *\n * Uses duck-typing: any object with a `pipe` function qualifies, covering\n * `Readable`, `Writable`, `Duplex`, `Transform`, and custom stream-compatible\n * objects without importing from `node:stream`.\n *\n * @param value - The value to check\n * @returns `true` if value is a Node.js stream\n * @example\n * import { Readable } from 'node:stream';\n * isNodeStream(new Readable()) // => true\n * isNodeStream({})             // => false\n * isNodeStream(null)           // => false\n * @since 2.0.3\n */\nexport function isNodeStream(value: unknown): value is { pipe: (...args: unknown[]) => unknown } {\n  return (\n    // Intentionally `object`-only, unlike `isPromiseLike` (see type/isPromiseLike.ts):\n    // a callable function exposing `.pipe()` would be an unusual, contrived stream shape.\n    value !== null &&\n    typeof value === 'object' &&\n    typeof (value as Record<string, unknown>)['pipe'] === 'function'\n  );\n}\n","/**\n * This file is part of helpers4.\n * Copyright (C) 2025 baxyz\n * SPDX-License-Identifier: LGPL-3.0-or-later\n */\n\n/**\n * Checks if a value is a `SharedArrayBuffer` instance.\n *\n * `SharedArrayBuffer` enables shared memory between the main thread and worker\n * threads. In browsers without COOP/COEP headers, `SharedArrayBuffer` may be\n * unavailable; this function returns `false` in that case.\n *\n * @param value - The value to check\n * @returns `true` if value is a SharedArrayBuffer\n * @example\n * isSharedArrayBuffer(new SharedArrayBuffer(8)) // => true\n * isSharedArrayBuffer(new ArrayBuffer(8))       // => false\n * isSharedArrayBuffer(null)                     // => false\n * @since 2.0.3\n */\nexport function isSharedArrayBuffer(value: unknown): value is SharedArrayBuffer {\n  return typeof SharedArrayBuffer !== 'undefined' && value instanceof SharedArrayBuffer;\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;AAwBA,SAAgB,SAAS,OAAiC;CACxD,OAAO,OAAO,WAAW,eAAe,iBAAiB;AAC3D;;;;;;;;;;;;;;;;;;;;;;;;ACJA,SAAgB,aAAa,OAAoE;CAC/F,OAGE,UAAU,QACV,OAAO,UAAU,YACjB,OAAQ,MAAkC,YAAY;AAE1D;;;;;;;;;;;;;;;;;;;;;;;ACTA,SAAgB,oBAAoB,OAA4C;CAC9E,OAAO,OAAO,sBAAsB,eAAe,iBAAiB;AACtE"}

package/llms.txt

@@ -1,7 +1,7 @@
 # @helpers4/node
 
 > Tree-shakable TypeScript utility functions for the `node` domain.
-> Package: `@helpers4/node` — Version: 2.0.1
+> Package: `@helpers4/node` — Version: 2.0.3
 > License: LGPL-3.0-or-later
 
 ## Installation
@@ -15,7 +15,7 @@ pnpm add @helpers4/node
 ## Usage
 
 ```typescript
-import { isBuffer } from '@helpers4/node';
+import { isBuffer, isNodeStream, isSharedArrayBuffer } from '@helpers4/node';
 ```
 
 ## Functions
@@ -23,6 +23,8 @@ import { isBuffer } from '@helpers4/node';
 | Function | Description |
 |---|---|
 | `isBuffer` | Checks if a value is a Node.js Buffer instance.  `Buffer` extends `Uint8Array` and is specific to No |
+| `isNodeStream` | Checks if a value is a Node.js stream (has a `.pipe()` method).  Uses duck-typing: any object with a |
+| `isSharedArrayBuffer` | Checks if a value is a `SharedArrayBuffer` instance.  `SharedArrayBuffer` enables shared memory betw |
 
 ---
 
@@ -74,3 +76,100 @@ values.filter(isBuffer)
 ```
 
 ---
+
+### `isNodeStream`
+
+Checks if a value is a Node.js stream (has a `.pipe()` method).
+
+Uses duck-typing: any object with a `pipe` function qualifies, covering
+`Readable`, `Writable`, `Duplex`, `Transform`, and custom stream-compatible
+objects without importing from `node:stream`.
+
+```typescript
+import { isNodeStream } from '@helpers4/node';
+
+isNodeStream(value: unknown): value is object
+```
+
+**Parameters:**
+
+- `value: unknown` — The value to check
+
+**Returns:** `value is object` — `true` if value is a Node.js stream
+
+**Examples:**
+
+*Detect a Node.js stream*
+
+Returns true for any object with a .pipe() method (Readable, Writable, Transform, etc.).
+
+```typescript
+import { Readable } from 'node:stream';
+isNodeStream(new Readable({ read() {} })) // => true
+isNodeStream({})                          // => false
+isNodeStream(null)                        // => false
+```
+
+*Guard before piping an unknown value*
+
+Use isNodeStream to safely pipe only known streams.
+
+```typescript
+import { Writable } from 'node:stream';
+function pipeToOutput(source: unknown, dest: Writable): void {
+  if (isNodeStream(source)) {
+    source.pipe(dest);
+  }
+}
+```
+
+---
+
+### `isSharedArrayBuffer`
+
+Checks if a value is a `SharedArrayBuffer` instance.
+
+`SharedArrayBuffer` enables shared memory between the main thread and worker
+threads. In browsers without COOP/COEP headers, `SharedArrayBuffer` may be
+unavailable; this function returns `false` in that case.
+
+```typescript
+import { isSharedArrayBuffer } from '@helpers4/node';
+
+isSharedArrayBuffer(value: unknown): value is SharedArrayBuffer
+```
+
+**Parameters:**
+
+- `value: unknown` — The value to check
+
+**Returns:** `value is SharedArrayBuffer` — `true` if value is a SharedArrayBuffer
+
+**Examples:**
+
+*Distinguish SharedArrayBuffer from ArrayBuffer*
+
+Returns true only for SharedArrayBuffer instances, not plain ArrayBuffers.
+
+```typescript
+isSharedArrayBuffer(new SharedArrayBuffer(8)) // => true
+isSharedArrayBuffer(new ArrayBuffer(8))       // => false
+isSharedArrayBuffer(null)                     // => false
+```
+
+*Safe shared memory check before worker communication*
+
+Use as a guard to ensure a buffer can be transferred to a Worker.
+
+```typescript
+function sendToWorker(buffer: unknown): void {
+  if (isSharedArrayBuffer(buffer)) {
+    // buffer is SharedArrayBuffer — can be shared directly
+    // worker.postMessage({ buffer });
+  } else {
+    // must transfer or copy
+  }
+}
+```
+
+---

package/meta/api.json

@@ -1,6 +1,6 @@
 {
   "category": "node",
-  "version": "2.0.1",
+  "version": "2.0.3",
   "functions": [
     {
       "name": "isBuffer",
@@ -37,6 +37,78 @@
         }
       ],
       "sourceFile": "isBuffer.ts"
+    },
+    {
+      "name": "isNodeStream",
+      "kind": "function",
+      "description": "Checks if a value is a Node.js stream (has a `.pipe()` method).\n\nUses duck-typing: any object with a `pipe` function qualifies, covering\n`Readable`, `Writable`, `Duplex`, `Transform`, and custom stream-compatible\nobjects without importing from `node:stream`.",
+      "since": "2.0.3",
+      "signatures": [
+        {
+          "signature": "isNodeStream(value: unknown): value is object",
+          "description": "Checks if a value is a Node.js stream (has a `.pipe()` method).\n\nUses duck-typing: any object with a `pipe` function qualifies, covering\n`Readable`, `Writable`, `Duplex`, `Transform`, and custom stream-compatible\nobjects without importing from `node:stream`.",
+          "params": [
+            {
+              "name": "value",
+              "type": "unknown",
+              "description": "The value to check"
+            }
+          ],
+          "returns": {
+            "type": "value is object",
+            "description": "`true` if value is a Node.js stream"
+          }
+        }
+      ],
+      "examples": [
+        {
+          "title": "Detect a Node.js stream",
+          "description": "Returns true for any object with a .pipe() method (Readable, Writable, Transform, etc.).",
+          "code": "import { Readable } from 'node:stream';\nisNodeStream(new Readable({ read() {} })) // => true\nisNodeStream({})                          // => false\nisNodeStream(null)                        // => false"
+        },
+        {
+          "title": "Guard before piping an unknown value",
+          "description": "Use isNodeStream to safely pipe only known streams.",
+          "code": "import { Writable } from 'node:stream';\nfunction pipeToOutput(source: unknown, dest: Writable): void {\n  if (isNodeStream(source)) {\n    source.pipe(dest);\n  }\n}"
+        }
+      ],
+      "sourceFile": "isNodeStream.ts"
+    },
+    {
+      "name": "isSharedArrayBuffer",
+      "kind": "function",
+      "description": "Checks if a value is a `SharedArrayBuffer` instance.\n\n`SharedArrayBuffer` enables shared memory between the main thread and worker\nthreads. In browsers without COOP/COEP headers, `SharedArrayBuffer` may be\nunavailable; this function returns `false` in that case.",
+      "since": "2.0.3",
+      "signatures": [
+        {
+          "signature": "isSharedArrayBuffer(value: unknown): value is SharedArrayBuffer",
+          "description": "Checks if a value is a `SharedArrayBuffer` instance.\n\n`SharedArrayBuffer` enables shared memory between the main thread and worker\nthreads. In browsers without COOP/COEP headers, `SharedArrayBuffer` may be\nunavailable; this function returns `false` in that case.",
+          "params": [
+            {
+              "name": "value",
+              "type": "unknown",
+              "description": "The value to check"
+            }
+          ],
+          "returns": {
+            "type": "value is SharedArrayBuffer",
+            "description": "`true` if value is a SharedArrayBuffer"
+          }
+        }
+      ],
+      "examples": [
+        {
+          "title": "Distinguish SharedArrayBuffer from ArrayBuffer",
+          "description": "Returns true only for SharedArrayBuffer instances, not plain ArrayBuffers.",
+          "code": "isSharedArrayBuffer(new SharedArrayBuffer(8)) // => true\nisSharedArrayBuffer(new ArrayBuffer(8))       // => false\nisSharedArrayBuffer(null)                     // => false"
+        },
+        {
+          "title": "Safe shared memory check before worker communication",
+          "description": "Use as a guard to ensure a buffer can be transferred to a Worker.",
+          "code": "function sendToWorker(buffer: unknown): void {\n  if (isSharedArrayBuffer(buffer)) {\n    // buffer is SharedArrayBuffer — can be shared directly\n    // worker.postMessage({ buffer });\n  } else {\n    // must transfer or copy\n  }\n}"
+        }
+      ],
+      "sourceFile": "isSharedArrayBuffer.ts"
     }
   ]
 }

package/meta/examples.json

@@ -15,6 +15,36 @@
           "code": "const values = [Buffer.from('a'), 'text', Buffer.alloc(4), 42];\nvalues.filter(isBuffer)\n// => [Buffer, Buffer]"
         }
       ]
+    },
+    {
+      "name": "isNodeStream",
+      "examples": [
+        {
+          "title": "Detect a Node.js stream",
+          "description": "Returns true for any object with a .pipe() method (Readable, Writable, Transform, etc.).",
+          "code": "import { Readable } from 'node:stream';\nisNodeStream(new Readable({ read() {} })) // => true\nisNodeStream({})                          // => false\nisNodeStream(null)                        // => false"
+        },
+        {
+          "title": "Guard before piping an unknown value",
+          "description": "Use isNodeStream to safely pipe only known streams.",
+          "code": "import { Writable } from 'node:stream';\nfunction pipeToOutput(source: unknown, dest: Writable): void {\n  if (isNodeStream(source)) {\n    source.pipe(dest);\n  }\n}"
+        }
+      ]
+    },
+    {
+      "name": "isSharedArrayBuffer",
+      "examples": [
+        {
+          "title": "Distinguish SharedArrayBuffer from ArrayBuffer",
+          "description": "Returns true only for SharedArrayBuffer instances, not plain ArrayBuffers.",
+          "code": "isSharedArrayBuffer(new SharedArrayBuffer(8)) // => true\nisSharedArrayBuffer(new ArrayBuffer(8))       // => false\nisSharedArrayBuffer(null)                     // => false"
+        },
+        {
+          "title": "Safe shared memory check before worker communication",
+          "description": "Use as a guard to ensure a buffer can be transferred to a Worker.",
+          "code": "function sendToWorker(buffer: unknown): void {\n  if (isSharedArrayBuffer(buffer)) {\n    // buffer is SharedArrayBuffer — can be shared directly\n    // worker.postMessage({ buffer });\n  } else {\n    // must transfer or copy\n  }\n}"
+        }
+      ]
     }
   ]
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@helpers4/node",
-  "version": "2.0.1",
+  "version": "2.0.3",
   "description": "A set of helpers in TS/JS, compatible with tree-shaking, for node.",
   "author": "baxyz <baxy@etik.com>",
   "license": "LGPL-3.0",
@@ -27,7 +27,9 @@
   "keywords": [
     "helpers",
     "node",
-    "isBuffer"
+    "isBuffer",
+    "isNodeStream",
+    "isSharedArrayBuffer"
   ],
   "files": [
     "lib/index.js",