@helpers4/number 2.0.0-beta.3 → 2.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/lib/index.d.ts +5 -5
- package/lib/index.js +5 -5
- package/lib/index.js.map +1 -1
- package/llms.txt +1 -1
- package/meta/api.json +6 -6
- package/package.json +1 -1
package/lib/index.d.ts
CHANGED
|
@@ -32,7 +32,7 @@ declare function clamp(value: number, min: number, max: number): number;
|
|
|
32
32
|
* formatCompact(1_000); // '1K'
|
|
33
33
|
* formatCompact(999); // '999'
|
|
34
34
|
* formatCompact(1_500_000, 'fr'); // '1,5 M'
|
|
35
|
-
* @since
|
|
35
|
+
* @since 2.0.0
|
|
36
36
|
*/
|
|
37
37
|
declare function formatCompact(value: number, locale?: string): string;
|
|
38
38
|
|
|
@@ -56,7 +56,7 @@ declare function formatCompact(value: number, locale?: string): string;
|
|
|
56
56
|
* formatSize(1536) // '1.5KB'
|
|
57
57
|
* formatSize(1_048_576) // '1.0MB'
|
|
58
58
|
* formatSize(1_073_741_824) // '1.0GB'
|
|
59
|
-
* @since
|
|
59
|
+
* @since 2.0.0
|
|
60
60
|
*/
|
|
61
61
|
declare function formatSize(bytes: number): string;
|
|
62
62
|
|
|
@@ -91,7 +91,7 @@ interface InRangeOptions {
|
|
|
91
91
|
* inRange(1, 1, 10) // => true (min inclusive)
|
|
92
92
|
* inRange(1, 1, 10, { inclusive: 'none' }) // => false
|
|
93
93
|
* inRange(10, 1, 10, { inclusive: 'max' }) // => true
|
|
94
|
-
* @since
|
|
94
|
+
* @since 2.0.0
|
|
95
95
|
*/
|
|
96
96
|
declare function inRange(value: number, min: number, max: number, options?: InRangeOptions): boolean;
|
|
97
97
|
|
|
@@ -116,7 +116,7 @@ declare function inRange(value: number, min: number, max: number, options?: InRa
|
|
|
116
116
|
* lerp(0, 100, 1); // 100
|
|
117
117
|
* lerp(0, 100, 0.5); // 50
|
|
118
118
|
* lerp(0, 100, 0.25); // 25
|
|
119
|
-
* @since
|
|
119
|
+
* @since 2.0.0
|
|
120
120
|
*/
|
|
121
121
|
declare function lerp(start: number, end: number, t: number): number;
|
|
122
122
|
|
|
@@ -137,7 +137,7 @@ declare function lerp(start: number, end: number, t: number): number;
|
|
|
137
137
|
* mean([1, 2, 3, 4]) // => 2.5
|
|
138
138
|
* mean([10]) // => 10
|
|
139
139
|
* mean([]) // => NaN
|
|
140
|
-
* @since
|
|
140
|
+
* @since 2.0.0
|
|
141
141
|
*/
|
|
142
142
|
declare function mean(array: readonly number[]): number;
|
|
143
143
|
|
package/lib/index.js
CHANGED
|
@@ -36,7 +36,7 @@ function clamp(value, min, max) {
|
|
|
36
36
|
* formatCompact(1_000); // '1K'
|
|
37
37
|
* formatCompact(999); // '999'
|
|
38
38
|
* formatCompact(1_500_000, 'fr'); // '1,5 M'
|
|
39
|
-
* @since
|
|
39
|
+
* @since 2.0.0
|
|
40
40
|
*/
|
|
41
41
|
function formatCompact(value, locale) {
|
|
42
42
|
return new Intl.NumberFormat(locale, { notation: "compact" }).format(value);
|
|
@@ -71,7 +71,7 @@ var UNITS = [
|
|
|
71
71
|
* formatSize(1536) // '1.5KB'
|
|
72
72
|
* formatSize(1_048_576) // '1.0MB'
|
|
73
73
|
* formatSize(1_073_741_824) // '1.0GB'
|
|
74
|
-
* @since
|
|
74
|
+
* @since 2.0.0
|
|
75
75
|
*/
|
|
76
76
|
function formatSize(bytes) {
|
|
77
77
|
let size = bytes;
|
|
@@ -97,7 +97,7 @@ function formatSize(bytes) {
|
|
|
97
97
|
* inRange(1, 1, 10) // => true (min inclusive)
|
|
98
98
|
* inRange(1, 1, 10, { inclusive: 'none' }) // => false
|
|
99
99
|
* inRange(10, 1, 10, { inclusive: 'max' }) // => true
|
|
100
|
-
* @since
|
|
100
|
+
* @since 2.0.0
|
|
101
101
|
*/
|
|
102
102
|
function inRange(value, min, max, options = {}) {
|
|
103
103
|
const { inclusive = "both" } = options;
|
|
@@ -126,7 +126,7 @@ function inRange(value, min, max, options = {}) {
|
|
|
126
126
|
* lerp(0, 100, 1); // 100
|
|
127
127
|
* lerp(0, 100, 0.5); // 50
|
|
128
128
|
* lerp(0, 100, 0.25); // 25
|
|
129
|
-
* @since
|
|
129
|
+
* @since 2.0.0
|
|
130
130
|
*/
|
|
131
131
|
function lerp(start, end, t) {
|
|
132
132
|
if (t === 0) return start;
|
|
@@ -153,7 +153,7 @@ function lerp(start, end, t) {
|
|
|
153
153
|
* mean([1, 2, 3, 4]) // => 2.5
|
|
154
154
|
* mean([10]) // => 10
|
|
155
155
|
* mean([]) // => NaN
|
|
156
|
-
* @since
|
|
156
|
+
* @since 2.0.0
|
|
157
157
|
*/
|
|
158
158
|
function mean(array) {
|
|
159
159
|
if (array.length === 0) return NaN;
|
package/lib/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","names":[],"sources":["../../../helpers/number/clamp.ts","../../../helpers/number/formatCompact.ts","../../../helpers/number/formatSize.ts","../../../helpers/number/inRange.ts","../../../helpers/number/lerp.ts","../../../helpers/number/mean.ts","../../../helpers/number/random.ts","../../../helpers/number/roundTo.ts","../../../helpers/number/sum.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 * Clamps a number between min and max values\n * @param value - The value to clamp\n * @param min - Minimum value\n * @param max - Maximum value\n * @returns Clamped value\n * @since 1.9.0\n */\nexport function clamp(value: number, min: number, max: number): number {\n return Math.min(Math.max(value, min), max);\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 * Formats a number using compact notation (e.g. `1_500_000 → \"1.5M\"`).\n *\n * Thin wrapper over `Intl.NumberFormat` with `notation: 'compact'`. Companion\n * of `formatSize` in the same `format*` family.\n *\n * @param value - The number to format.\n * @param locale - BCP 47 locale tag. Defaults to the runtime locale.\n * @returns A compact string representation of the number.\n * @example\n * formatCompact(1_500_000); // '1.5M' (en-US locale)\n * formatCompact(1_000); // '1K'\n * formatCompact(999); // '999'\n * formatCompact(1_500_000, 'fr'); // '1,5 M'\n * @since
|
|
1
|
+
{"version":3,"file":"index.js","names":[],"sources":["../../../helpers/number/clamp.ts","../../../helpers/number/formatCompact.ts","../../../helpers/number/formatSize.ts","../../../helpers/number/inRange.ts","../../../helpers/number/lerp.ts","../../../helpers/number/mean.ts","../../../helpers/number/random.ts","../../../helpers/number/roundTo.ts","../../../helpers/number/sum.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 * Clamps a number between min and max values\n * @param value - The value to clamp\n * @param min - Minimum value\n * @param max - Maximum value\n * @returns Clamped value\n * @since 1.9.0\n */\nexport function clamp(value: number, min: number, max: number): number {\n return Math.min(Math.max(value, min), max);\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 * Formats a number using compact notation (e.g. `1_500_000 → \"1.5M\"`).\n *\n * Thin wrapper over `Intl.NumberFormat` with `notation: 'compact'`. Companion\n * of `formatSize` in the same `format*` family.\n *\n * @param value - The number to format.\n * @param locale - BCP 47 locale tag. Defaults to the runtime locale.\n * @returns A compact string representation of the number.\n * @example\n * formatCompact(1_500_000); // '1.5M' (en-US locale)\n * formatCompact(1_000); // '1K'\n * formatCompact(999); // '999'\n * formatCompact(1_500_000, 'fr'); // '1,5 M'\n * @since 2.0.0\n */\nexport function formatCompact(value: number, locale?: string): string {\n return new Intl.NumberFormat(locale, { notation: 'compact' }).format(value);\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/** Size units in ascending order. */\nconst UNITS = ['B', 'KB', 'MB', 'GB', 'TB'] as const;\n\n/**\n * Format a byte count into a human-readable string with the appropriate unit.\n *\n * Each unit is 1024 of the previous (binary prefix). The result is formatted\n * with one decimal place.\n *\n * @param bytes - A non-negative integer representing a byte count.\n * @returns A human-readable string such as `'0.0B'`, `'1.5KB'`, `'3.2MB'`.\n * @example\n * formatSize(0) // '0.0B'\n * formatSize(512) // '512.0B'\n * formatSize(1024) // '1.0KB'\n * formatSize(1536) // '1.5KB'\n * formatSize(1_048_576) // '1.0MB'\n * formatSize(1_073_741_824) // '1.0GB'\n * @since 2.0.0\n */\nexport function formatSize(bytes: number): string {\n let size = bytes;\n let unitIndex = 0;\n\n while (size >= 1024 && unitIndex < UNITS.length - 1) {\n size /= 1024;\n unitIndex++;\n }\n\n return `${size.toFixed(1)}${UNITS[unitIndex]}`;\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 * Options for {@link inRange}.\n */\nexport interface InRangeOptions {\n /**\n * Which boundary (or boundaries) are included in the range.\n * - `'both'` (default): `min <= value <= max`\n * - `'min'`: `min <= value < max`\n * - `'max'`: `min < value <= max`\n * - `'none'`: `min < value < max`\n */\n inclusive?: 'both' | 'min' | 'max' | 'none';\n}\n\n/**\n * Checks whether a number falls within `[min, max]` (both inclusive by default).\n *\n * @param value - The number to test\n * @param min - Lower bound\n * @param max - Upper bound\n * @param options - Boundary inclusion mode (default: `'both'`)\n * @returns `true` if `value` is within the specified range\n * @example\n * inRange(5, 1, 10) // => true\n * inRange(1, 1, 10) // => true (min inclusive)\n * inRange(1, 1, 10, { inclusive: 'none' }) // => false\n * inRange(10, 1, 10, { inclusive: 'max' }) // => true\n * @since 2.0.0\n */\nexport function inRange(value: number, min: number, max: number, options: InRangeOptions = {}): boolean {\n const { inclusive = 'both' } = options;\n const minOk = inclusive === 'both' || inclusive === 'min' ? value >= min : value > min;\n const maxOk = inclusive === 'both' || inclusive === 'max' ? value <= max : value < max;\n return minOk && maxOk;\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 * Linearly interpolates between `start` and `end` by the factor `t`.\n *\n * - `t = 0` returns `start`.\n * - `t = 1` returns `end`.\n * - Values of `t` outside `[0, 1]` extrapolate beyond the range.\n *\n * @param start - The start value.\n * @param end - The end value.\n * @param t - The interpolation factor.\n * @returns The interpolated value.\n * @example\n * lerp(0, 100, 0); // 0\n * lerp(0, 100, 1); // 100\n * lerp(0, 100, 0.5); // 50\n * lerp(0, 100, 0.25); // 25\n * @since 2.0.0\n */\nexport function lerp(start: number, end: number, t: number): number {\n if (t === 0) return start;\n if (t === 1) return end;\n if (Object.is(start, end)) return start;\n return start + (end - start) * t;\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 * Calculates the arithmetic mean (average) of an array of numbers.\n * Returns `NaN` for an empty array.\n *\n * Pairs with {@link sum} for aggregate operations.\n *\n * @param array - The array of numbers to average\n * @returns The arithmetic mean, or `NaN` if the array is empty\n * @example\n * mean([1, 2, 3, 4]) // => 2.5\n * mean([10]) // => 10\n * mean([]) // => NaN\n * @since 2.0.0\n */\nexport function mean(array: readonly number[]): number {\n if (array.length === 0) return NaN;\n return array.reduce((acc, n) => acc + n, 0) / array.length;\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 * Generates a random number between min and max (inclusive)\n * @param min - Minimum value\n * @param max - Maximum value\n * @returns Random number between min and max\n * @since 1.9.0\n */\nexport function randomBetween(min: number, max: number): number {\n return Math.random() * (max - min) + min;\n}\n\n/**\n * Generates a random integer between min and max (inclusive)\n * @param min - Minimum value\n * @param max - Maximum value\n * @returns Random integer between min and max\n * @since 1.9.0\n */\nexport function randomIntBetween(min: number, max: number): number {\n return Math.floor(Math.random() * (max - min + 1)) + min;\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 * Rounds a number to specified decimal places\n * @param value - The number to round\n * @param decimals - Number of decimal places\n * @returns Rounded number\n * @since 1.9.0\n */\nexport function roundTo(value: number, decimals: number): number {\n const multiplier = Math.pow(10, decimals);\n return Math.round(value * multiplier) / multiplier;\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 * Calculates the sum of an array of numbers.\n * @param array - The array of numbers to sum\n * @returns The sum of all values\n * @example\n * sum([1, 2, 3, 4])\n * // => 10\n * @since 2.0.0\n */\nexport function sum(array: readonly number[]): number {\n return array.reduce((acc, n) => acc + n, 0);\n}\n"],"mappings":";;;;;;;;;;;;;;AAcA,SAAgB,MAAM,OAAe,KAAa,KAAqB;CACrE,OAAO,KAAK,IAAI,KAAK,IAAI,OAAO,GAAG,GAAG,GAAG;AAC3C;;;;;;;;;;;;;;;;;;;;;;;;ACMA,SAAgB,cAAc,OAAe,QAAyB;CACpE,OAAO,IAAI,KAAK,aAAa,QAAQ,EAAE,UAAU,UAAU,CAAC,EAAE,OAAO,KAAK;AAC5E;;;;;;;;;ACjBA,IAAM,QAAQ;CAAC;CAAK;CAAM;CAAM;CAAM;AAAI;;;;;;;;;;;;;;;;;;AAmB1C,SAAgB,WAAW,OAAuB;CAChD,IAAI,OAAO;CACX,IAAI,YAAY;CAEhB,OAAO,QAAQ,QAAQ,YAAY,MAAM,SAAS,GAAG;EACnD,QAAQ;EACR;CACF;CAEA,OAAO,GAAG,KAAK,QAAQ,CAAC,IAAI,MAAM;AACpC;;;;;;;;;;;;;;;;;;ACDA,SAAgB,QAAQ,OAAe,KAAa,KAAa,UAA0B,CAAC,GAAY;CACtG,MAAM,EAAE,YAAY,WAAW;CAG/B,QAFc,cAAc,UAAU,cAAc,QAAQ,SAAS,MAAM,QAAQ,SACrE,cAAc,UAAU,cAAc,QAAQ,SAAS,MAAM,QAAQ;AAErF;;;;;;;;;;;;;;;;;;;;;;;;;;AChBA,SAAgB,KAAK,OAAe,KAAa,GAAmB;CAClE,IAAI,MAAM,GAAG,OAAO;CACpB,IAAI,MAAM,GAAG,OAAO;CACpB,IAAI,OAAO,GAAG,OAAO,GAAG,GAAG,OAAO;CAClC,OAAO,SAAS,MAAM,SAAS;AACjC;;;;;;;;;;;;;;;;;;;;;;ACTA,SAAgB,KAAK,OAAkC;CACrD,IAAI,MAAM,WAAW,GAAG,OAAO;CAC/B,OAAO,MAAM,QAAQ,KAAK,MAAM,MAAM,GAAG,CAAC,IAAI,MAAM;AACtD;;;;;;;;;;;;;;;ACVA,SAAgB,cAAc,KAAa,KAAqB;CAC9D,OAAO,KAAK,OAAO,KAAK,MAAM,OAAO;AACvC;;;;;;;;AASA,SAAgB,iBAAiB,KAAa,KAAqB;CACjE,OAAO,KAAK,MAAM,KAAK,OAAO,KAAK,MAAM,MAAM,EAAE,IAAI;AACvD;;;;;;;;;;;;;;;ACbA,SAAgB,QAAQ,OAAe,UAA0B;CAC/D,MAAM,aAAa,KAAK,IAAI,IAAI,QAAQ;CACxC,OAAO,KAAK,MAAM,QAAQ,UAAU,IAAI;AAC1C;;;;;;;;;;;;;;;;;ACDA,SAAgB,IAAI,OAAkC;CACpD,OAAO,MAAM,QAAQ,KAAK,MAAM,MAAM,GAAG,CAAC;AAC5C"}
|
package/llms.txt
CHANGED
package/meta/api.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"category": "number",
|
|
3
|
-
"version": "2.0.0
|
|
3
|
+
"version": "2.0.0",
|
|
4
4
|
"functions": [
|
|
5
5
|
{
|
|
6
6
|
"name": "clamp",
|
|
@@ -47,7 +47,7 @@
|
|
|
47
47
|
"name": "formatCompact",
|
|
48
48
|
"kind": "function",
|
|
49
49
|
"description": "Formats a number using compact notation (e.g. `1_500_000 → \"1.5M\"`).\n\nThin wrapper over `Intl.NumberFormat` with `notation: 'compact'`. Companion\nof `formatSize` in the same `format*` family.",
|
|
50
|
-
"since": "
|
|
50
|
+
"since": "2.0.0",
|
|
51
51
|
"signatures": [
|
|
52
52
|
{
|
|
53
53
|
"signature": "formatCompact(value: number, locale?: string): string",
|
|
@@ -89,7 +89,7 @@
|
|
|
89
89
|
"name": "formatSize",
|
|
90
90
|
"kind": "function",
|
|
91
91
|
"description": "Format a byte count into a human-readable string with the appropriate unit.\n\nEach unit is 1024 of the previous (binary prefix). The result is formatted\nwith one decimal place.",
|
|
92
|
-
"since": "
|
|
92
|
+
"since": "2.0.0",
|
|
93
93
|
"signatures": [
|
|
94
94
|
{
|
|
95
95
|
"signature": "formatSize(bytes: number): string",
|
|
@@ -120,7 +120,7 @@
|
|
|
120
120
|
"name": "inRange",
|
|
121
121
|
"kind": "function",
|
|
122
122
|
"description": "Checks whether a number falls within `[min, max]` (both inclusive by default).",
|
|
123
|
-
"since": "
|
|
123
|
+
"since": "2.0.0",
|
|
124
124
|
"signatures": [
|
|
125
125
|
{
|
|
126
126
|
"signature": "inRange(value: number, min: number, max: number, options: InRangeOptions): boolean",
|
|
@@ -179,7 +179,7 @@
|
|
|
179
179
|
"name": "lerp",
|
|
180
180
|
"kind": "function",
|
|
181
181
|
"description": "Linearly interpolates between `start` and `end` by the factor `t`.\n\n- `t = 0` returns `start`.\n- `t = 1` returns `end`.\n- Values of `t` outside `[0, 1]` extrapolate beyond the range.",
|
|
182
|
-
"since": "
|
|
182
|
+
"since": "2.0.0",
|
|
183
183
|
"signatures": [
|
|
184
184
|
{
|
|
185
185
|
"signature": "lerp(start: number, end: number, t: number): number",
|
|
@@ -225,7 +225,7 @@
|
|
|
225
225
|
"name": "mean",
|
|
226
226
|
"kind": "function",
|
|
227
227
|
"description": "Calculates the arithmetic mean (average) of an array of numbers.\nReturns `NaN` for an empty array.\n\nPairs with sum for aggregate operations.",
|
|
228
|
-
"since": "
|
|
228
|
+
"since": "2.0.0",
|
|
229
229
|
"signatures": [
|
|
230
230
|
{
|
|
231
231
|
"signature": "mean(array: readonly number[]): number",
|