@helpers4/number 2.0.0-alpha.11 → 2.0.0-alpha.14

package/llms.txt

@@ -0,0 +1,200 @@
+# @helpers4/number
+
+> Tree-shakable TypeScript utility functions for the `number` domain.
+> Package: `@helpers4/number` — Version: 2.0.0-alpha.14
+> License: LGPL-3.0-or-later
+
+## Installation
+
+```sh
+npm install @helpers4/number
+# or
+pnpm add @helpers4/number
+```
+
+## Usage
+
+```typescript
+import { clamp, randomBetween, randomIntBetween, ... } from '@helpers4/number';
+```
+
+## Functions
+
+| Function | Description |
+|---|---|
+| `clamp` | Clamps a number between min and max values |
+| `randomBetween` | Generates a random number between min and max (inclusive) |
+| `randomIntBetween` | Generates a random integer between min and max (inclusive) |
+| `roundTo` | Rounds a number to specified decimal places |
+| `sum` | Calculates the sum of an array of numbers. |
+
+---
+
+## API Reference
+
+### `clamp`
+
+Clamps a number between min and max values
+
+```typescript
+import { clamp } from '@helpers4/number';
+
+clamp(value: number, min: number, max: number): number
+```
+
+**Parameters:**
+
+- `value: number` — The value to clamp
+- `min: number` — Minimum value
+- `max: number` — Maximum value
+
+**Returns:** `number` — Clamped value
+
+**Examples:**
+
+*Clamp a value within range*
+
+Restricts a number to be within a min/max range.
+
+```typescript
+clamp(15, 0, 10)  // => 10
+clamp(-5, 0, 10)  // => 0
+clamp(5, 0, 10)   // => 5
+```
+
+---
+
+### `randomBetween`
+
+Generates a random number between min and max (inclusive)
+
+```typescript
+import { randomBetween } from '@helpers4/number';
+
+randomBetween(min: number, max: number): number
+```
+
+**Parameters:**
+
+- `min: number` — Minimum value
+- `max: number` — Maximum value
+
+**Returns:** `number` — Random number between min and max
+
+**Examples:**
+
+*Generate a random float in range*
+
+Returns a random number between min and max (inclusive).
+
+```typescript
+randomBetween(1, 10)
+// => e.g. 5.327...
+```
+
+*Generate a random integer in range*
+
+Returns a random integer between min and max (inclusive).
+
+```typescript
+randomIntBetween(1, 6)
+// => e.g. 4
+```
+
+---
+
+### `randomIntBetween`
+
+Generates a random integer between min and max (inclusive)
+
+```typescript
+import { randomIntBetween } from '@helpers4/number';
+
+randomIntBetween(min: number, max: number): number
+```
+
+**Parameters:**
+
+- `min: number` — Minimum value
+- `max: number` — Maximum value
+
+**Returns:** `number` — Random integer between min and max
+
+---
+
+### `roundTo`
+
+Rounds a number to specified decimal places
+
+```typescript
+import { roundTo } from '@helpers4/number';
+
+roundTo(value: number, decimals: number): number
+```
+
+**Parameters:**
+
+- `value: number` — The number to round
+- `decimals: number` — Number of decimal places
+
+**Returns:** `number` — Rounded number
+
+**Examples:**
+
+*Round to 2 decimal places*
+
+Rounds a floating-point number to the specified number of decimals.
+
+```typescript
+roundTo(3.14159, 2)
+// => 3.14
+```
+
+*Round to 0 decimal places*
+
+Effectively rounds to the nearest integer.
+
+```typescript
+roundTo(3.7, 0)
+// => 4
+```
+
+---
+
+### `sum`
+
+Calculates the sum of an array of numbers.
+
+```typescript
+import { sum } from '@helpers4/number';
+
+sum(array: readonly number[]): number
+```
+
+**Parameters:**
+
+- `array: readonly number[]` — The array of numbers to sum
+
+**Returns:** `number` — The sum of all values
+
+**Examples:**
+
+*Sum numbers*
+
+Calculates the sum of an array of numbers.
+
+```typescript
+sum([1, 2, 3, 4])
+// => 10
+```
+
+*Sum with negative numbers*
+
+Handles negative numbers correctly.
+
+```typescript
+sum([10, -3, 5, -2])
+// => 10
+```
+
+---

package/meta/api.json

@@ -1,6 +1,6 @@
 {
   "category": "number",
-  "version": "2.0.0-alpha.11",
+  "version": "2.0.0-alpha.14",
   "functions": [
     {
       "name": "clamp",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@helpers4/number",
-  "version": "2.0.0-alpha.11",
+  "version": "2.0.0-alpha.14",
   "description": "A set of helpers in TS/JS, compatible with tree-shaking, for number.",
   "author": "baxyz <baxy@etik.com>",
   "license": "LGPL-3.0",
@@ -21,6 +21,7 @@
     "./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": [
@@ -36,6 +37,7 @@
     "lib/index.d.ts",
     "lib/index.js.map",
     "meta/",
+    "llms.txt",
     "LICENSE.md",
     "package.json",
     "README.md"