docs: add number util fns

README.md

@@ -78,6 +78,13 @@ await sleep(1000); // It suspends the exection for 1 second.
 - [percentage](https://js-utils.pages.dev/docs/Maths/percentage)
 - [percentageOf](https://js-utils.pages.dev/docs/Maths/percentageOf)
 
+## Number
+
+- [clamp](https://js-utils.pages.dev/docs/Number/clamp)
+- [isNegZero](https://js-utils.pages.dev/docs/Number/isNegZero)
+- [isZero](https://js-utils.pages.dev/docs/Number/isZero)
+- [toNum](https://js-utils.pages.dev/docs/Number/toNum)
+
 ### Function
 
 - [sleep](https://js-utils.pages.dev/docs/Timers/sleep)

apps/docs/pages/Number/_meta.json

@@ -0,0 +1,6 @@
+{
+  "clamp": "clamp",
+  "isNegZero": "isNegZero",
+  "isZero": "isZero",
+  "toNum": "toNum"
+}

apps/docs/pages/Number/clamp.mdx

@@ -0,0 +1,30 @@
+import REPL from "../../components/REPL";
+
+> Returns a value clamped to the inclusive range of min and max.
+
+## Syntax
+
+```ts
+import { clamp } from '@opentf/utils';
+
+clamp(val: number, min: number, max: number): number;
+```
+
+## Examples
+
+```ts
+clamp(10, -5, 5) //=> 5
+
+clamp(0, 1000, 1366) //=> 1000
+
+clamp(1001, 1000, 1366) //=> 1001
+
+clamp(1500, 1000, 1366) //=> 1366
+```
+
+## Try
+
+<REPL code={`const { clamp } = require('@opentf/utils');
+
+clamp(0, 1000, 1366);
+`} />

apps/docs/pages/Number/isNegZero.mdx

@@ -0,0 +1,36 @@
+import { Callout } from "nextra/components";
+import REPL from "../../components/REPL";
+
+> Checks if the given number is negative zero (-0).
+
+<Callout type="info">
+In JavaScript 0 === -0 is true.
+</Callout>
+
+## Syntax
+
+```ts
+import { isNegZero } from '@opentf/utils';
+
+isNegZero(n: number): boolean;
+```
+
+## Examples
+
+```ts
+isNegZero(0) //=> false
+
+isNegZero(-0) //=> true
+
+isNegZero(-0.0) //=> true
+
+isNegZero(-0x0) //=> true
+```
+
+## Try
+
+<REPL code={`const { isNegZero } = require('@opentf/utils');
+
+log(isNegZero(0));
+isNegZero(-0);
+`} />

apps/docs/pages/Number/isZero.mdx

@@ -0,0 +1,40 @@
+import { Callout } from "nextra/components";
+import REPL from "../../components/REPL";
+
+> Checks if the given number is positive zero (0).
+
+<Callout type="info">
+In JavaScript 0 === -0 is true.
+</Callout>
+
+## Syntax
+
+```ts
+import { isZero } from '@opentf/utils';
+
+isZero(n: number): boolean;
+```
+
+## Examples
+
+```ts
+isZero(0) //=> true
+
+isZero(0.0) //=> true
+
+isZero(0x0) //=> true
+
+isZero(-0) //=> false
+
+isZero(-0.0) //=> false
+
+isZero(-0x0) //=> false
+```
+
+## Try
+
+<REPL code={`const { isZero } = require('@opentf/utils');
+
+log(isZero(0));
+isZero(-0);
+`} />

apps/docs/pages/Number/toNum.mdx

@@ -0,0 +1,35 @@
+import { Callout } from "nextra/components";
+import REPL from "../../components/REPL";
+
+> Try to convert the given value into a finite number.
+
+## Syntax
+
+```ts
+import { toNum } from '@opentf/utils';
+
+toNum(val: unknown): number;
+```
+
+## Examples
+
+```ts
+toNum(1) //=> 1
+
+toNum('1.3') //=> 1.3
+
+toNum('1_000') //=> 1000
+
+toNum(Infinity) //=> NaN
+
+toNum('a') //=> NaN
+
+toNum('0xF') //=> 15
+```
+
+## Try
+
+<REPL code={`const { toNum } = require('@opentf/utils');
+
+toNum('1_000');
+`} />

packages/utils/README.md

@@ -78,6 +78,13 @@ await sleep(1000); // It suspends the exection for 1 second.
 - [percentage](https://js-utils.pages.dev/docs/Maths/percentage)
 - [percentageOf](https://js-utils.pages.dev/docs/Maths/percentageOf)
 
+## Number
+
+- [clamp](https://js-utils.pages.dev/docs/Number/clamp)
+- [isNegZero](https://js-utils.pages.dev/docs/Number/isNegZero)
+- [isZero](https://js-utils.pages.dev/docs/Number/isZero)
+- [toNum](https://js-utils.pages.dev/docs/Number/toNum)
+
 ### Function
 
 - [sleep](https://js-utils.pages.dev/docs/Timers/sleep)

packages/utils/src/number/isNegZero.ts

@@ -3,11 +3,9 @@
  *
  * @example
  *
- * isNegZero() //=> false
- * isNegZero(null) //=> false
- * isNegZero('') //=> false
  * isNegZero(0) //=> false
- * isNegZero(-0) //=> true */
+ * isNegZero(-0) //=> true
+ */
 
 export default function isNegZero(n: number): boolean {
   return Object.is(n, -0);

packages/utils/src/number/isZero.ts

@@ -3,9 +3,6 @@
  *
  * @example
  *
- * isZero() //=> false
- * isZero(null) //=> false
- * isZero('') //=> false
  * isZero(-0) //=> false
  * isZero(0) //=> true
  */

packages/utils/src/object/merge.ts

@@ -1,6 +1,10 @@
 import isArr from '../types/isArr';
 import isObj from '../types/isObj';
 
+type IterableObj = {
+  [key: number | string]: unknown;
+};
+
 /**
  * It deeply merges objects or arrays.
  *
@@ -9,10 +13,6 @@ import isObj from '../types/isObj';
  * const b = { a: { c: 2 } };
  * merge(a, b); //=> {a: { b: 1, c: 2 } }
  */
-type IterableObj = {
-  [key: number | string]: unknown;
-};
-
 export default function merge(...objs: object[]) {
   const filteredObjs = objs.filter((v) => isArr(v) || isObj(v));
   const initialVal = isArr(filteredObjs[0]) ? [] : {};

packages/utils/src/object/shallowMerge.ts

@@ -4,7 +4,9 @@ import isArr from '../types/isArr';
  * Shallow merges objects or arrays.
  *
  * @example
- *
+ * const a = { a: 1 };
+ * const b = { b: 2 };
+ * shallowMerge(a, b); //=> { a: 1, b: 2 }
  */
 export default function shallowMerge(...objs: object[]) {
   return objs.reduce((acc, cur) => {

packages/utils/src/object/shallowMergeAll.ts

@@ -1,12 +1,17 @@
+import isArr from '../types/isArr';
+
 /**
- * Shallow merges objects or arrays and also returns union of array items.
+ * Shallow merges objects and concatenates the array.
  *
  * @example
- *
+ * const a = [1];
+ * const b = [2];
+ * const c = [3];
+ * shallowMergeAll(a, b, c); //=> [1, 2, 3]
  */
 export default function shallowMergeAll(...objs: object[]) {
   return objs.reduce((acc, cur) => {
-    if (Array.isArray(cur) && Array.isArray(acc)) {
+    if (isArr(cur) && isArr(acc)) {
       return [...acc, ...cur];
     }