@helpers4/node 2.0.0-alpha.0

package/LICENSE.md

@@ -0,0 +1,160 @@
+### GNU LESSER GENERAL PUBLIC LICENSE
+
+Version 3, 29 June 2007
+
+Copyright (C) 2007 Free Software Foundation, Inc.
+<https://fsf.org/\>
+
+Everyone is permitted to copy and distribute verbatim copies of this
+license document, but changing it is not allowed.
+
+This version of the GNU Lesser General Public License incorporates the
+terms and conditions of version 3 of the GNU General Public License,
+supplemented by the additional permissions listed below.
+
+#### 0. Additional Definitions.
+
+As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the
+GNU General Public License.
+
+"The Library" refers to a covered work governed by this License, other
+than an Application or a Combined Work as defined below.
+
+An "Application" is any work that makes use of an interface provided by
+the Library, but which is not otherwise based on the Library. Defining a
+subclass of a class defined by the Library is deemed a mode of using an
+interface provided by the Library.
+
+A "Combined Work" is a work produced by combining or linking an
+Application with the Library. The particular version of the Library with
+which the Combined Work was made is also called the "Linked Version".
+
+The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+#### 1. Exception to Section 3 of the GNU GPL.
+
+You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+#### 2. Conveying Modified Versions.
+
+If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified version:
+
+- **a)** under this License, provided that you make a good faith effort
+  to ensure that, in the event an Application does not supply the
+  function or data, the facility still operates, and performs whatever
+  part of its purpose remains meaningful, or
+
+- **b)** under the GNU GPL, with none of the additional permissions of
+  this License applicable to that copy.
+
+#### 3. Object Code Incorporating Material from Library Header Files.
+
+The object code form of an Application may incorporate material from a
+header file that is part of the Library. You may convey such object code
+under terms of your choice, provided that, if the incorporated material
+is not limited to numerical parameters, data structure layouts and
+accessors, or small macros, inline functions and templates (ten or fewer
+lines in length), you do both of the following:
+
+- **a)** Give prominent notice with each copy of the object code that
+  the Library is used in it and that the Library and its use are covered
+  by this License.
+
+- **b)** Accompany the object code with a copy of the GNU GPL and this
+  license document.
+
+#### 4. Combined Works.
+
+You may convey a Combined Work under terms of your choice that, taken
+together, effectively do not restrict modification of the portions of
+the Library contained in the Combined Work and reverse engineering for
+debugging such modifications, if you also do each of the following:
+
+- **a)** Give prominent notice with each copy of the Combined Work that
+  the Library is used in it and that the Library and its use are covered
+  by this License.
+
+- **b)** Accompany the Combined Work with a copy of the GNU GPL and
+  this license document.
+
+- **c)** For a Combined Work that displays copyright notices during
+  execution, include the copyright notice for the Library among these
+  notices, as well as a reference directing the user to the copies of
+  the GNU GPL and this license document.
+
+- **d)** Do one of the following:
+
+  - **0)** Convey the Minimal Corresponding Source under the terms of
+    this License, and the Corresponding Application Code in a form
+    suitable for, and under terms that permit, the user to recombine or
+    relink the Application with a modified version of the Linked Version
+    to produce a modified Combined Work, in the manner specified by
+    section 6 of the GNU GPL for conveying Corresponding Source.
+
+  - **1)** Use a suitable shared library mechanism for linking with the
+    Library. A suitable mechanism is one that (a) uses at run time a copy
+    of the Library already present on the user's computer system, and (b)
+    will operate properly with a modified version of the Library that is
+    interface-compatible with the Linked Version.
+
+- **e)** Provide Installation Information, but only if you would
+  otherwise be required to provide such information under section 6 of
+  the GNU GPL, and only to the extent that such information is necessary
+  to install and execute a modified version of the Combined Work produced
+  by recombining or relinking the Application with a modified version of
+  the Linked Version. (If you use option 4d0, the Installation
+  Information must accompany the Minimal Corresponding Source and
+  Corresponding Application Code. If you use option 4d1, you must
+  provide the Installation Information in the manner specified by
+  section 6 of the GNU GPL for conveying Corresponding Source.)
+
+#### 5. Combined Libraries.
+
+You may place library facilities that are a work based on the Library
+side by side in a single library together with other library facilities
+that are not Applications and are not covered by this License, and
+convey such a combined library under terms of your choice, if you do
+both of the following:
+
+- **a)** Accompany the combined library with a copy of the same work
+  based on the Library, uncombined with any other library facilities,
+  conveyed under the terms of this License.
+
+- **b)** Give prominent notice with the combined library that part of
+  it is a work based on the Library, and explaining where to find the
+  accompanying uncombined form of the same work.
+
+#### 6. Revised Versions of the GNU Lesser General Public License.
+
+The Free Software Foundation may publish revised and/or new versions of
+the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+Each version is given a distinguishing version number. If the Library as
+you received it specifies that a certain numbered version of the GNU
+Lesser General Public License "or any later version" applies to it, you
+have the option of following the terms and conditions either of that
+published version or of any later version published by the Free Software
+Foundation. If the Library as you received it does not specify a version
+number of the GNU Lesser General Public License, you may choose any
+version of the GNU Lesser General Public License ever published by the
+Free Software Foundation.
+
+If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the Library.

package/README.md

@@ -0,0 +1,73 @@
+# @helpers4
+
+The `@helpers4` are a collection of helper functions for use in any project, whatever the framework.
+Every helper is a standalone module and supports tree-shaking, so you can use only the helpers you need without embedding the whole library.
+
+## @helpers4/node
+
+A set of helpers for working with URLs.
+
+## Documentation
+
+[https://helpers4.dev/typescript/categories/node/](https://helpers4.dev/typescript/categories/node/)
+
+<!-- AUTOMATIC-METHODS -->
+- isBuffer
+<!-- /AUTOMATIC-METHODS -->
+
+## See
+
+<!-- AUTOMATIC-SIBLINGS -->
+- [array](../array)
+- [ci](../ci)
+- [commit](../commit)
+- [date](../date)
+- [function](../function)
+- [id](../id)
+- [markdown](../markdown)
+- [number](../number)
+- [object](../object)
+- [observable](../observable)
+- [promise](../promise)
+- [string](../string)
+- [type](../type)
+- [url](../url)
+- [version](../version)
+<!-- /AUTOMATIC-SIBLINGS -->
+
+## All Available Packages
+
+<!-- AUTOMATIC-CATEGORIES-TABLE -->
+| Name | Package | Source Code | Description |
+|------|---------|-------------|-------------|
+| array | [@helpers4/array](https://www.npmjs.com/package/@helpers4/array) | [Source](https://github.com/helpers4/helpers4/tree/main/helpers/array) | Array manipulation utilities |
+| ci | [@helpers4/ci](https://www.npmjs.com/package/@helpers4/ci) | [Source](https://github.com/helpers4/helpers4/tree/main/helpers/ci) | CI/CD workflow status utilities |
+| commit | [@helpers4/commit](https://www.npmjs.com/package/@helpers4/commit) | [Source](https://github.com/helpers4/helpers4/tree/main/helpers/commit) | Conventional Commits parsing and analysis |
+| date | [@helpers4/date](https://www.npmjs.com/package/@helpers4/date) | [Source](https://github.com/helpers4/helpers4/tree/main/helpers/date) | Date and time utility functions |
+| function | [@helpers4/function](https://www.npmjs.com/package/@helpers4/function) | [Source](https://github.com/helpers4/helpers4/tree/main/helpers/function) | Function utilities and type guards |
+| id | [@helpers4/id](https://www.npmjs.com/package/@helpers4/id) | [Source](https://github.com/helpers4/helpers4/tree/main/helpers/id) | Unique identifier generation utilities |
+| markdown | [@helpers4/markdown](https://www.npmjs.com/package/@helpers4/markdown) | [Source](https://github.com/helpers4/helpers4/tree/main/helpers/markdown) | Markdown formatting and escaping utilities |
+| node | [@helpers4/node](https://www.npmjs.com/package/@helpers4/node) | [Source](https://github.com/helpers4/helpers4/tree/main/helpers/node) | Node.js-specific utilities |
+| number | [@helpers4/number](https://www.npmjs.com/package/@helpers4/number) | [Source](https://github.com/helpers4/helpers4/tree/main/helpers/number) | Number utility functions and validation |
+| object | [@helpers4/object](https://www.npmjs.com/package/@helpers4/object) | [Source](https://github.com/helpers4/helpers4/tree/main/helpers/object) | Object manipulation utilities |
+| observable | [@helpers4/observable](https://www.npmjs.com/package/@helpers4/observable) | [Source](https://github.com/helpers4/helpers4/tree/main/helpers/observable) | Observable utilities and combinators |
+| promise | [@helpers4/promise](https://www.npmjs.com/package/@helpers4/promise) | [Source](https://github.com/helpers4/helpers4/tree/main/helpers/promise) | Promise utilities and error handling |
+| string | [@helpers4/string](https://www.npmjs.com/package/@helpers4/string) | [Source](https://github.com/helpers4/helpers4/tree/main/helpers/string) | String manipulation and formatting utilities |
+| type | [@helpers4/type](https://www.npmjs.com/package/@helpers4/type) | [Source](https://github.com/helpers4/helpers4/tree/main/helpers/type) | Type checking and validation utilities |
+| url | [@helpers4/url](https://www.npmjs.com/package/@helpers4/url) | [Source](https://github.com/helpers4/helpers4/tree/main/helpers/url) | URL parsing and manipulation utilities |
+| version | [@helpers4/version](https://www.npmjs.com/package/@helpers4/version) | [Source](https://github.com/helpers4/helpers4/tree/main/helpers/version) | Version string manipulation utilities |
+<!-- /AUTOMATIC-CATEGORIES-TABLE -->
+
+## Contributors
+
+<table>
+<tr>
+    <td align="center" style="word-wrap: break-word; width: 150.0; height: 150.0">
+        <a href=https://github.com/baxyz>
+            <img src=https://avatars.githubusercontent.com/u/7852177?v=4 width="100;" alt=baxyz/>
+            <br />
+            <sub style="font-size:14px"><b>baxyz</b></sub>
+        </a>
+    </td>
+</tr>
+</table>

package/lib/index.d.ts

@@ -0,0 +1,26 @@
+/**
+ * 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 Buffer instance.
+ *
+ * `Buffer` extends `Uint8Array` and is specific to Node.js, Bun, and Deno.
+ * In browser-only environments where `Buffer` is not defined, this function
+ * always returns `false`.
+ *
+ * Useful for filtering or type-narrowing in a functional pipeline:
+ * `values.filter(isBuffer)`
+ *
+ * @param value - The value to check
+ * @returns True if value is a Buffer
+ * @example
+ * isBuffer(Buffer.from('hello')) // => true
+ * isBuffer(new Uint8Array(8))    // => false
+ * isBuffer('hello')              // => false
+ * @since 2.0.0
+ */
+declare function isBuffer(value: unknown): value is Buffer;
+
+export { isBuffer };

package/lib/index.js

@@ -0,0 +1,31 @@
+//#region helpers/node/isBuffer.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 Buffer instance.
+*
+* `Buffer` extends `Uint8Array` and is specific to Node.js, Bun, and Deno.
+* In browser-only environments where `Buffer` is not defined, this function
+* always returns `false`.
+*
+* Useful for filtering or type-narrowing in a functional pipeline:
+* `values.filter(isBuffer)`
+*
+* @param value - The value to check
+* @returns True if value is a Buffer
+* @example
+* isBuffer(Buffer.from('hello')) // => true
+* isBuffer(new Uint8Array(8))    // => false
+* isBuffer('hello')              // => false
+* @since 2.0.0
+*/
+function isBuffer(value) {
+	return typeof Buffer !== "undefined" && value instanceof Buffer;
+}
+//#endregion
+export { isBuffer };
+
+//# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -0,0 +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"}

package/llms.txt

@@ -0,0 +1,76 @@
+# @helpers4/node
+
+> Tree-shakable TypeScript utility functions for the `node` domain.
+> Package: `@helpers4/node` — Version: 2.0.0
+> License: LGPL-3.0-or-later
+
+## Installation
+
+```sh
+npm install @helpers4/node
+# or
+pnpm add @helpers4/node
+```
+
+## Usage
+
+```typescript
+import { isBuffer } from '@helpers4/node';
+```
+
+## Functions
+
+| Function | Description |
+|---|---|
+| `isBuffer` | Checks if a value is a Node.js Buffer instance.  `Buffer` extends `Uint8Array` and is specific to No |
+
+---
+
+## API Reference
+
+### `isBuffer`
+
+Checks if a value is a Node.js Buffer instance.
+
+`Buffer` extends `Uint8Array` and is specific to Node.js, Bun, and Deno.
+In browser-only environments where `Buffer` is not defined, this function
+always returns `false`.
+
+Useful for filtering or type-narrowing in a functional pipeline:
+`values.filter(isBuffer)`
+
+```typescript
+import { isBuffer } from '@helpers4/node';
+
+isBuffer(value: unknown): value is Buffer<ArrayBufferLike>
+```
+
+**Parameters:**
+
+- `value: unknown` — The value to check
+
+**Returns:** `value is Buffer<ArrayBufferLike>` — True if value is a Buffer
+
+**Examples:**
+
+*Detect a Node.js Buffer*
+
+Returns true only for Buffer instances. Uint8Array is not a Buffer.
+
+```typescript
+isBuffer(Buffer.from('hello')) // => true
+isBuffer(new Uint8Array(8))    // => false
+isBuffer('hello')              // => false
+```
+
+*Filter Buffers from a mixed array*
+
+Use as a predicate in .filter() to extract Buffer values.
+
+```typescript
+const values = [Buffer.from('a'), 'text', Buffer.alloc(4), 42];
+values.filter(isBuffer)
+// => [Buffer, Buffer]
+```
+
+---

package/meta/api.json

@@ -0,0 +1,42 @@
+{
+  "category": "node",
+  "version": "2.0.0",
+  "functions": [
+    {
+      "name": "isBuffer",
+      "kind": "function",
+      "description": "Checks if a value is a Node.js Buffer instance.\n\n`Buffer` extends `Uint8Array` and is specific to Node.js, Bun, and Deno.\nIn browser-only environments where `Buffer` is not defined, this function\nalways returns `false`.\n\nUseful for filtering or type-narrowing in a functional pipeline:\n`values.filter(isBuffer)`",
+      "since": "2.0.0",
+      "signatures": [
+        {
+          "signature": "isBuffer(value: unknown): value is Buffer<ArrayBufferLike>",
+          "description": "Checks if a value is a Node.js Buffer instance.\n\n`Buffer` extends `Uint8Array` and is specific to Node.js, Bun, and Deno.\nIn browser-only environments where `Buffer` is not defined, this function\nalways returns `false`.\n\nUseful for filtering or type-narrowing in a functional pipeline:\n`values.filter(isBuffer)`",
+          "params": [
+            {
+              "name": "value",
+              "type": "unknown",
+              "description": "The value to check"
+            }
+          ],
+          "returns": {
+            "type": "value is Buffer<ArrayBufferLike>",
+            "description": "True if value is a Buffer"
+          }
+        }
+      ],
+      "examples": [
+        {
+          "title": "Detect a Node.js Buffer",
+          "description": "Returns true only for Buffer instances. Uint8Array is not a Buffer.",
+          "code": "isBuffer(Buffer.from('hello')) // => true\nisBuffer(new Uint8Array(8))    // => false\nisBuffer('hello')              // => false"
+        },
+        {
+          "title": "Filter Buffers from a mixed array",
+          "description": "Use as a predicate in .filter() to extract Buffer values.",
+          "code": "const values = [Buffer.from('a'), 'text', Buffer.alloc(4), 42];\nvalues.filter(isBuffer)\n// => [Buffer, Buffer]"
+        }
+      ],
+      "sourceFile": "isBuffer.ts"
+    }
+  ]
+}

package/meta/category.json

@@ -0,0 +1,9 @@
+{
+  "category": "node",
+  "label": "Node",
+  "smallDescription": "Node.js-specific utilities",
+  "description": "Utilities specific to Node.js, Bun, and Deno runtimes (Buffer, streams, etc.)",
+  "peerDependencies": {
+    "@types/node": ">=22"
+  }
+}

package/meta/examples.json

@@ -0,0 +1,20 @@
+{
+  "category": "node",
+  "functions": [
+    {
+      "name": "isBuffer",
+      "examples": [
+        {
+          "title": "Detect a Node.js Buffer",
+          "description": "Returns true only for Buffer instances. Uint8Array is not a Buffer.",
+          "code": "isBuffer(Buffer.from('hello')) // => true\nisBuffer(new Uint8Array(8))    // => false\nisBuffer('hello')              // => false"
+        },
+        {
+          "title": "Filter Buffers from a mixed array",
+          "description": "Use as a predicate in .filter() to extract Buffer values.",
+          "code": "const values = [Buffer.from('a'), 'text', Buffer.alloc(4), 42];\nvalues.filter(isBuffer)\n// => [Buffer, Buffer]"
+        }
+      ]
+    }
+  ]
+}

package/meta/licenses.json

@@ -0,0 +1,4 @@
+{
+  "category": "node",
+  "dependencies": []
+}

package/package.json

@@ -0,0 +1,48 @@
+{
+  "name": "@helpers4/node",
+  "version": "2.0.0-alpha.0",
+  "description": "A set of helpers in TS/JS, compatible with tree-shaking, for node.",
+  "author": "baxyz <baxy@etik.com>",
+  "license": "LGPL-3.0",
+  "homepage": "https://helpers4.dev/typescript/categories/node/",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/helpers4/typescript.git"
+  },
+  "type": "module",
+  "sideEffects": false,
+  "main": "lib/index.js",
+  "types": "lib/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./lib/index.d.ts",
+      "import": "./lib/index.js"
+    },
+    "./meta/api.json": "./meta/api.json",
+    "./meta/examples.json": "./meta/examples.json",
+    "./meta/licenses.json": "./meta/licenses.json",
+    "./llms.txt": "./llms.txt",
+    "./package.json": "./package.json"
+  },
+  "keywords": [
+    "helpers",
+    "node",
+    "isBuffer"
+  ],
+  "files": [
+    "lib/index.js",
+    "lib/index.d.ts",
+    "lib/index.js.map",
+    "meta/",
+    "llms.txt",
+    "LICENSE.md",
+    "package.json",
+    "README.md"
+  ],
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "peerDependencies": {
+    "@types/node": "^25.9.1"
+  }
+}