@rzl-zone/utils-js 2.0.1 → 3.0.0-beta.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/dist/NumberRangeUnion-DC-C3_Kq.d.ts +26 -0
- package/dist/any-BmdI8UbK.d.ts +67 -0
- package/dist/array-CIZRbqTF.d.ts +223 -0
- package/dist/arrays-normalize-recursive-CnjYJ9xg.d.ts +72 -0
- package/dist/assertions/index.cjs +1 -0
- package/dist/assertions/index.d.ts +428 -0
- package/dist/assertions/index.js +1 -0
- package/dist/chunk-2TRAPBZ7.cjs +1 -0
- package/dist/chunk-3D74QO5D.cjs +1 -0
- package/dist/chunk-4DK3RCC4.js +2 -0
- package/dist/chunk-4JOQ45HL.js +1 -0
- package/dist/chunk-55CZALRS.js +1 -0
- package/dist/chunk-56QBKKRE.js +1 -0
- package/dist/chunk-5JFV3GDE.cjs +4 -0
- package/dist/chunk-5SZUSNGZ.js +1 -0
- package/dist/chunk-62HX5Z45.cjs +1 -0
- package/dist/chunk-7NA6DUHR.cjs +2 -0
- package/dist/chunk-7YWAQOA4.cjs +1 -0
- package/dist/chunk-BVPMMWDL.cjs +1 -0
- package/dist/chunk-BYZAD3XN.cjs +1 -0
- package/dist/chunk-CEFYHEM4.cjs +1 -0
- package/dist/chunk-CN53M4QZ.cjs +1 -0
- package/dist/chunk-D47MHBSD.cjs +1 -0
- package/dist/chunk-DGH75GJD.js +1 -0
- package/dist/chunk-E5NUI7PN.js +1 -0
- package/dist/chunk-ELDDNERR.js +1 -0
- package/dist/chunk-EXZ47NOW.js +1 -0
- package/dist/chunk-FDITZ5C6.cjs +1 -0
- package/dist/chunk-FF76ISQ2.js +1 -0
- package/dist/chunk-FIEZKTAZ.cjs +1 -0
- package/dist/chunk-FSSV24W7.cjs +1 -0
- package/dist/chunk-G5LXIEFO.js +0 -0
- package/dist/chunk-GCGU2WB7.js +1 -0
- package/dist/chunk-GECI2YBP.js +1 -0
- package/dist/chunk-GQE4OVHC.cjs +1 -0
- package/dist/chunk-GRVZXQXL.cjs +1 -0
- package/dist/chunk-I4AVNHPA.cjs +1 -0
- package/dist/chunk-JFRL7NKU.js +4 -0
- package/dist/chunk-JWHM3WZQ.cjs +1 -0
- package/dist/chunk-KCQDDZJE.cjs +1 -0
- package/dist/chunk-L54ZPSYJ.js +1 -0
- package/dist/chunk-LVKAYEZ4.js +1 -0
- package/dist/chunk-MBDWTK54.cjs +1 -0
- package/dist/chunk-MMSYCIJ2.cjs +1 -0
- package/dist/chunk-MNGGDB2G.js +1 -0
- package/dist/chunk-MY7BA4GI.cjs +1 -0
- package/dist/chunk-N2IJPIND.cjs +1 -0
- package/dist/chunk-NIMNTEGV.js +1 -0
- package/dist/chunk-NNM7QCNB.js +1 -0
- package/dist/chunk-PUQXRLZH.cjs +1 -0
- package/dist/chunk-PVJF2JHM.js +1 -0
- package/dist/chunk-QCFXEUKL.js +1 -0
- package/dist/chunk-QFCGBBSY.js +1 -0
- package/dist/chunk-QQYAUPSK.cjs +1 -0
- package/dist/chunk-RN3TP3S3.js +1 -0
- package/dist/chunk-RV2VULM7.cjs +1 -0
- package/dist/chunk-SW6HYEW7.cjs +1 -0
- package/dist/chunk-SYJC7UAW.js +1 -0
- package/dist/chunk-TC4VBE4Y.cjs +1 -0
- package/dist/chunk-TUXDINHF.cjs +1 -0
- package/dist/chunk-U5Y2FXMN.cjs +1 -0
- package/dist/chunk-UUPQI6ND.cjs +1 -0
- package/dist/chunk-VYCGZ2S6.js +1 -0
- package/dist/chunk-W5EDKJK3.js +1 -0
- package/dist/chunk-WHAVUFEU.js +1 -0
- package/dist/chunk-XCFIOTCV.js +1 -0
- package/dist/chunk-XE27XPJR.js +1 -0
- package/dist/chunk-XH6MCRLP.js +1 -0
- package/dist/chunk-XVB3ZZEB.js +1 -0
- package/dist/chunk-ZBSIGJFO.cjs +1 -0
- package/dist/chunk-ZYAML74V.js +1 -0
- package/dist/conversions/index.cjs +1 -0
- package/dist/conversions/index.d.ts +1633 -0
- package/dist/conversions/index.js +1 -0
- package/dist/env/index.cjs +1 -0
- package/dist/env/index.d.ts +19 -0
- package/dist/env/index.js +1 -0
- package/dist/events/index.cjs +1 -0
- package/dist/events/index.d.ts +119 -0
- package/dist/events/index.js +1 -0
- package/dist/extends-Mp81Hq9-.d.ts +145 -0
- package/dist/formatting/index.cjs +1 -0
- package/dist/formatting/index.d.ts +912 -0
- package/dist/formatting/index.js +1 -0
- package/dist/generator/index.cjs +1 -0
- package/dist/generator/index.d.ts +163 -0
- package/dist/generator/index.js +1 -0
- package/dist/if-CvT4R7Kh.d.ts +18 -0
- package/dist/index.cjs +1 -1
- package/dist/index.d.ts +1 -4313
- package/dist/index.js +1 -1
- package/dist/is-array-Ckm_47hw.d.ts +1557 -0
- package/dist/isPlainObject-BKYaI6a8.d.ts +182 -0
- package/dist/never-BfayMBF9.d.ts +75 -0
- package/dist/next/index.cjs +8 -1
- package/dist/next/index.d.ts +169 -169
- package/dist/next/index.js +8 -1
- package/dist/next/server/index.cjs +2 -1
- package/dist/next/server/index.d.ts +37 -37
- package/dist/next/server/index.js +2 -1
- package/dist/nils-DMz3kU7M.d.ts +177 -0
- package/dist/omit-VvmIsZmX.d.ts +28 -0
- package/dist/operations/index.cjs +1 -0
- package/dist/operations/index.d.ts +182 -0
- package/dist/operations/index.js +1 -0
- package/dist/parsers/index.cjs +1 -0
- package/dist/parsers/index.d.ts +37 -0
- package/dist/parsers/index.js +1 -0
- package/dist/predicates/index.cjs +1 -0
- package/dist/predicates/index.d.ts +1839 -0
- package/dist/predicates/index.js +1 -0
- package/dist/prettify-C4xLcYOP.d.ts +353 -0
- package/dist/promise/index.cjs +1 -0
- package/dist/promise/index.d.ts +40 -0
- package/dist/promise/index.js +1 -0
- package/dist/rzl-utils.global.js +4 -1
- package/dist/strings/index.cjs +1 -0
- package/dist/strings/index.d.ts +816 -0
- package/dist/strings/index.js +1 -0
- package/dist/stylings/index.cjs +1 -0
- package/dist/stylings/index.d.ts +49 -0
- package/dist/stylings/index.js +1 -0
- package/dist/type-data-DDs-u2kq.d.ts +261 -0
- package/dist/types/index.d.ts +3589 -2090
- package/dist/urls/index.cjs +1 -0
- package/dist/urls/index.d.ts +418 -0
- package/dist/urls/index.js +1 -0
- package/package.json +147 -21
|
@@ -0,0 +1,1839 @@
|
|
|
1
|
+
import{m as IsPositive,P as ParseNumber,I as IsStringLiteral,C as CharAt,o as AnyString,a as IsEmptyString,T as Trim,e as IsUnknown,p as IsReadonlyArray,t as IsArray,h as OrArr}from'../is-array-Ckm_47hw.js';import{I as IsAny}from'../any-BmdI8UbK.js';import{A as AnyFunction,a as AnObjectNonArray,T as TypedArray}from'../type-data-DDs-u2kq.js';import{E as Extends}from'../extends-Mp81Hq9-.js';import{P as Prettify}from'../prettify-C4xLcYOP.js';import{N as NumberRangeUnion}from'../NumberRangeUnion-DC-C3_Kq.js';import{a as IsPlainObjectResult}from'../isPlainObject-BKYaI6a8.js';export{G as GetPreciseTypeOptions,I as IsNumberOptions,g as getPreciseType,i as isNumber,b as isPlainObject}from'../isPlainObject-BKYaI6a8.js';import{I as IsNever}from'../never-BfayMBF9.js';import'../if-CvT4R7Kh.js';import'../array-CIZRbqTF.js';type EmptyObject<T>={[K in keyof T]?:never;};type EmptyObjectOf<T>=EmptyObject<T>extends T?EmptyObject<T>:never;type List<T>=ArrayLike<T>;type IsEqualCustomizer=(value:unknown,other:unknown,indexOrKey:PropertyKey,parent:unknown,otherParent:unknown,stack:unknown)=>boolean|undefined;type isMatchWithCustomizer=(value:unknown,other:unknown,indexOrKey:PropertyKey,object:object,source:object)=>boolean|undefined;
|
|
2
|
+
/** ----------------------------------------------------------
|
|
3
|
+
* * ***Compares two arrays deeply to check if they are equal.***
|
|
4
|
+
* ----------------------------------------------------------
|
|
5
|
+
*
|
|
6
|
+
* Supports deep comparison of arrays containing nested arrays or objects.
|
|
7
|
+
* Can also ignore the order of elements at all levels by recursively sorting.
|
|
8
|
+
*
|
|
9
|
+
* ----------------------------------------------------------
|
|
10
|
+
*
|
|
11
|
+
* @param {unknown[]} array1
|
|
12
|
+
* The first array to compare. Can contain nested arrays or objects.
|
|
13
|
+
*
|
|
14
|
+
* @param {unknown[]} array2
|
|
15
|
+
* The second array to compare against. Should match structure of `array1`.
|
|
16
|
+
*
|
|
17
|
+
* @param {boolean} [ignoreOrder=false]
|
|
18
|
+
* Whether to ignore the order of elements when comparing.
|
|
19
|
+
* If `true`, will sort both arrays recursively before comparing.
|
|
20
|
+
* Default is `false`.
|
|
21
|
+
*
|
|
22
|
+
* @returns {boolean}
|
|
23
|
+
* Returns `true` if both arrays are deeply equal, otherwise `false`.
|
|
24
|
+
*
|
|
25
|
+
* @throws {TypeError}
|
|
26
|
+
* Throws if `array1` or `array2` are not arrays, or if `ignoreOrder` is not a boolean.
|
|
27
|
+
*
|
|
28
|
+
* @example
|
|
29
|
+
* ```ts
|
|
30
|
+
* areArraysEqual([1, 2, 3], [1, 2, 3]);
|
|
31
|
+
* // → true
|
|
32
|
+
*
|
|
33
|
+
* areArraysEqual([1, 2, 3], [3, 2, 1]);
|
|
34
|
+
* // → false
|
|
35
|
+
*
|
|
36
|
+
* areArraysEqual([1, 2, 3], [3, 2, 1], true);
|
|
37
|
+
* // → true (order ignored)
|
|
38
|
+
*
|
|
39
|
+
* areArraysEqual([{ x: 1 }, { y: 2 }], [{ y: 2 }, { x: 1 }], true);
|
|
40
|
+
* // → true
|
|
41
|
+
* ```
|
|
42
|
+
*/
|
|
43
|
+
declare const areArraysEqual:(array1:unknown[],array2:unknown[],ignoreOrder?:boolean)=>boolean;
|
|
44
|
+
/** ---------------------------------
|
|
45
|
+
* * ***Compares two objects for deep equality.***
|
|
46
|
+
* ---------------------------------
|
|
47
|
+
*
|
|
48
|
+
* @template T1 The type of the first object.
|
|
49
|
+
* @template T2 The type of the second object.
|
|
50
|
+
* @param {T1} object1 - The first object to compare.
|
|
51
|
+
* @param {T2} object2 - The second object to compare.
|
|
52
|
+
* @returns {boolean} `true` if both objects are deeply equal, otherwise `false`.
|
|
53
|
+
*
|
|
54
|
+
* @example
|
|
55
|
+
* areObjectsEqual({ a: 1, b: 2 }, { a: 1, b: 2 }); // Returns true
|
|
56
|
+
* areObjectsEqual({ a: 1 }, { a: 1, b: undefined }); // Returns false
|
|
57
|
+
* areObjectsEqual([1, 2, 3], [1, 2, 3]); // Returns true
|
|
58
|
+
*/
|
|
59
|
+
declare const areObjectsEqual:(object1:unknown,object2:unknown)=>boolean;
|
|
60
|
+
/** ---------------------------------
|
|
61
|
+
* * ***Checks if two URLs are the same, ignoring query parameters.***
|
|
62
|
+
* ---------------------------------
|
|
63
|
+
*
|
|
64
|
+
* This function compares only the protocol, host, and pathname.
|
|
65
|
+
*
|
|
66
|
+
* @param {URL} urlA - The first URL to compare.
|
|
67
|
+
* @param {URL} urlB - The second URL to compare.
|
|
68
|
+
* @returns {boolean} Returns `true` if both URLs are the same (ignoring search parameters), otherwise `false`.
|
|
69
|
+
*/
|
|
70
|
+
declare const areURLsEqualPath:(urlA:URL,urlB:URL)=>boolean;
|
|
71
|
+
/** ---------------------------------
|
|
72
|
+
* * ***Checks if two URLs are exactly the same, including protocol, host, pathname, and query parameters.***
|
|
73
|
+
* ---------------------------------
|
|
74
|
+
*
|
|
75
|
+
* @param {URL} urlA - The first URL to compare.
|
|
76
|
+
* @param {URL} urlB - The second URL to compare.
|
|
77
|
+
* @returns {boolean} Returns `true` if both URLs are identical, otherwise `false`.
|
|
78
|
+
*/
|
|
79
|
+
declare const areURLsIdentical:(urlA:URL,urlB:URL)=>boolean;
|
|
80
|
+
/** ----------------------------------------------------------
|
|
81
|
+
* * ***Checks if the given `text` contains all of the specified `searchWords`.***
|
|
82
|
+
* ----------------------------------------------------------
|
|
83
|
+
*
|
|
84
|
+
* - ✅ Uses **regular expressions** for flexible pattern matching.
|
|
85
|
+
* - ✅ **Escapes special characters** to prevent regex injection attacks.
|
|
86
|
+
* - ✅ **Trims input** to avoid false positives with empty spaces.
|
|
87
|
+
* - ✅ **Supports exact word matching** (optional).
|
|
88
|
+
*
|
|
89
|
+
* @param {string} text - The text to search within.
|
|
90
|
+
* @param {string[]} searchWords - An array of words/phrases to match against the text.
|
|
91
|
+
* @param {boolean} [options.exactMatch=false] - If `true`, matches whole words only, defaultValue is `false`.
|
|
92
|
+
* @param {string} [options.flags="i"] - Optional regex flags (default: `"i"` for case-insensitive).
|
|
93
|
+
* @returns {boolean} - `true` if all `searchWords` are found in `text`, otherwise `false`.
|
|
94
|
+
*
|
|
95
|
+
* @example
|
|
96
|
+
* textContainsAll("Hello world, WithAI APP", ["Hello", "world"]); // true
|
|
97
|
+
* textContainsAll("JavaScript and TypeScript", ["Java", "Script"]); // true
|
|
98
|
+
* textContainsAll("Machine Learning", ["AI", "Learning"]); // false
|
|
99
|
+
* textContainsAll("open-source", ["open"], { exactMatch: true }); // false (because options `exactMatch=true`)
|
|
100
|
+
*/
|
|
101
|
+
declare const textContainsAll:<T extends string>(text:T,searchWords:T[]|string[],options?:{
|
|
102
|
+
/** If `true`, matches whole words only, defaultValue is `false`. */
|
|
103
|
+
exactMatch?:boolean;
|
|
104
|
+
/** Optional regex flags (default: `"i"` for case-insensitive). */
|
|
105
|
+
flags?:string;})=>boolean;
|
|
106
|
+
/** ----------------------------------------------------------
|
|
107
|
+
* * ***Checks if the given `text` contains at least one of the specified `searchWords`.***
|
|
108
|
+
* ----------------------------------------------------------
|
|
109
|
+
*
|
|
110
|
+
* - ✅ Uses **regular expressions** for flexible pattern matching.
|
|
111
|
+
* - ✅ **Escapes special characters** to prevent regex injection attacks.
|
|
112
|
+
* - ✅ **Trims input** to avoid false positives with empty spaces.
|
|
113
|
+
* - ✅ **Supports exact word matching** (optional).
|
|
114
|
+
*
|
|
115
|
+
* @param {string} text - The text to search within.
|
|
116
|
+
* @param {string[]} searchWords - An array of words/phrases to match against the text.
|
|
117
|
+
* @param {boolean} [options.exactMatch=false] - If `true`, matches whole words only, defaultValue is `false`.
|
|
118
|
+
* @param {string} [options.flags="i"] - Optional regex flags (default: `"i"` for case-insensitive).
|
|
119
|
+
* @returns {boolean} - `true` if at least one `searchWord` is found in `text`, otherwise `false`.
|
|
120
|
+
*
|
|
121
|
+
* @example
|
|
122
|
+
* textContainsAny("Hello world", ["hello", "test"]); // true
|
|
123
|
+
* textContainsAny("withAI APP", ["chat", "ai"]); // false
|
|
124
|
+
* textContainsAny("TypeScript is great!", ["script", "java"]); // true
|
|
125
|
+
* textContainsAny("open-source", ["open"], { exactMatch: true }); // false (because options `exactMatch=true`)
|
|
126
|
+
*/
|
|
127
|
+
declare const textContainsAny:<T extends string>(text:T,searchWords:T[]|string[],options?:{
|
|
128
|
+
/** If `true`, matches whole words only, defaultValue is `false`. */
|
|
129
|
+
exactMatch?:boolean;
|
|
130
|
+
/** Optional regex flags (default: `"i"` for case-insensitive). */
|
|
131
|
+
flags?:string;})=>boolean;
|
|
132
|
+
/** ----------------------------------------------------------
|
|
133
|
+
* * ***Recursively checks if a given key exists in an object or array.***
|
|
134
|
+
* ----------------------------------------------------------
|
|
135
|
+
*
|
|
136
|
+
* - ✅ **Supports deeply nested objects and arrays**, searching recursively.
|
|
137
|
+
* - ✅ Uses `Object.prototype.hasOwnProperty.call()` to safely check if the key exists at each level,
|
|
138
|
+
* even if its value is `null` or `undefined`.
|
|
139
|
+
* - ✅ Optimized to return `true` immediately when the key is found (short-circuits).
|
|
140
|
+
* - ✅ Handles edge cases gracefully:
|
|
141
|
+
* - Returns `false` for `null`, `undefined`, or non-object inputs.
|
|
142
|
+
* - Returns `false` if key is not found anywhere, even in deeply nested structures.
|
|
143
|
+
*
|
|
144
|
+
* ⚠️ Note: This function only checks for **the existence of the key itself**,
|
|
145
|
+
* not whether its value is non-null or non-undefined.
|
|
146
|
+
* If you need to check for both existence and meaningful value, write a stricter function.
|
|
147
|
+
*
|
|
148
|
+
* @template T - The type of the input object or array.
|
|
149
|
+
* @param {T | Record<string, unknown> | unknown[]} object - The object or array to search.
|
|
150
|
+
* @param {PropertyKey} key - The key to look for (string, number, or symbol).
|
|
151
|
+
* @returns {boolean} Returns `true` if the key exists anywhere in the object or array (even with `null` / `undefined` value), otherwise `false`.
|
|
152
|
+
*
|
|
153
|
+
* @example
|
|
154
|
+
* doesKeyExist({ name: "John", age: 30 }, "age"); // true
|
|
155
|
+
* doesKeyExist({ user: { profile: { email: "test@example.com" } } }, "email"); // true
|
|
156
|
+
* doesKeyExist([{ id: 1 }, { id: 2 }], "id"); // true
|
|
157
|
+
* doesKeyExist({ a: { b: { c: 10 } } }, "d"); // false
|
|
158
|
+
* doesKeyExist(null, "name"); // false
|
|
159
|
+
* doesKeyExist(undefined, "test"); // false
|
|
160
|
+
*
|
|
161
|
+
* @example
|
|
162
|
+
* // Key exists even if value is null or undefined:
|
|
163
|
+
* doesKeyExist({ a: null, b: undefined, c: { d: null } }, "a"); // true
|
|
164
|
+
* doesKeyExist({ a: null, b: undefined, c: { d: null } }, "b"); // true
|
|
165
|
+
* doesKeyExist({ a: null, b: undefined, c: { d: null } }, "d"); // true
|
|
166
|
+
*
|
|
167
|
+
* @example
|
|
168
|
+
* doesKeyExist({ a: 1 }, true); // ❌ Throws TypeError
|
|
169
|
+
* doesKeyExist({ a: 1 }, ["not", "valid"]); // ❌ Throws TypeError
|
|
170
|
+
*/
|
|
171
|
+
declare const doesKeyExist:(object:Record<string,unknown>|unknown[],key:PropertyKey)=>boolean;
|
|
172
|
+
/** ----------------------------------------------------------
|
|
173
|
+
* * ***Checks if at least one element from `targetArray` exists in `sourceArray`.***
|
|
174
|
+
* ----------------------------------------------------------
|
|
175
|
+
*
|
|
176
|
+
* - ✅ Uses `Set` for **faster lookup** compared to `Array.prototype.includes()`.
|
|
177
|
+
* - ✅ Supports **any data type** (`number`, `string`, `boolean`, `object`, `array`, `function`, etc.).
|
|
178
|
+
* - ✅ Uses **reference equality** for non-primitive values (object, array, function).
|
|
179
|
+
* - ✅ Returns `false` if either array is missing, empty, or not an array.
|
|
180
|
+
*
|
|
181
|
+
* @template T - The expected type of array elements.
|
|
182
|
+
*
|
|
183
|
+
* @param {T[]} [sourceArray] - The array to search within.
|
|
184
|
+
* @param {T[]} [targetArray] - The array containing elements to match.
|
|
185
|
+
*
|
|
186
|
+
* @returns {boolean}
|
|
187
|
+
* - `true` if **at least one element from `targetArray` is strictly found in `sourceArray`**.
|
|
188
|
+
* - Comparison uses:
|
|
189
|
+
* - **Value equality** for primitives (`number`, `string`, `boolean`, `null`, `undefined`).
|
|
190
|
+
* - **Reference equality** for objects, arrays, and functions.
|
|
191
|
+
* - `false` if:
|
|
192
|
+
* - No matching elements exist,
|
|
193
|
+
* - Either array is not provided, not an actual array, or is empty.
|
|
194
|
+
*
|
|
195
|
+
* @example
|
|
196
|
+
* arrayHasAnyMatch(["apple", "banana", "cherry"], ["banana", "grape"]); // → true
|
|
197
|
+
* arrayHasAnyMatch(["red", "blue"], ["green", "yellow"]); // → false
|
|
198
|
+
* arrayHasAnyMatch([1, 2, 3], [3, 4, 5]); // → true
|
|
199
|
+
* arrayHasAnyMatch([], ["test"]); // → false
|
|
200
|
+
* arrayHasAnyMatch(["A", "B", "C"], []); // → false
|
|
201
|
+
*
|
|
202
|
+
* @example
|
|
203
|
+
* const obj = { x: 1 };
|
|
204
|
+
* arrayHasAnyMatch([obj], [obj]); // → true (same reference)
|
|
205
|
+
* arrayHasAnyMatch([{ x: 1 }], [{ x: 1 }]); // → false (different reference)
|
|
206
|
+
*
|
|
207
|
+
* @example
|
|
208
|
+
* const fn = () => "hello";
|
|
209
|
+
* arrayHasAnyMatch([fn], [fn]); // → true
|
|
210
|
+
* arrayHasAnyMatch([() => "hello"], [() => "hello"]); // → false (different function reference)
|
|
211
|
+
*
|
|
212
|
+
* @example
|
|
213
|
+
* const arr = [1, 2];
|
|
214
|
+
* arrayHasAnyMatch([arr], [arr]); // → true
|
|
215
|
+
* arrayHasAnyMatch([[1, 2]], [[1, 2]]); // → false (different array object)
|
|
216
|
+
*/
|
|
217
|
+
declare const arrayHasAnyMatch:<T>(sourceArray?:T[],targetArray?:T[])=>boolean;
|
|
218
|
+
/** Restrict array indices to a fixed numeric range (1–25). */
|
|
219
|
+
type ArrayIndex=NumberRangeUnion<1,25>;
|
|
220
|
+
/** Remove `undefined` from a type. */
|
|
221
|
+
type NonUndef<T>=T extends undefined?never:T;
|
|
222
|
+
/** Remove `null` from a type. */
|
|
223
|
+
type NonNull<T>=T extends null?never:T;
|
|
224
|
+
/** Convert optional boolean for "discard undefined" to actual boolean. */
|
|
225
|
+
type EffectiveDiscardUndefined<O extends boolean|undefined>=O extends boolean?O:true;
|
|
226
|
+
/** Convert optional boolean for "discard null" to actual boolean. */
|
|
227
|
+
type EffectiveDiscardNull<O extends boolean|undefined>=O extends boolean?O:false;
|
|
228
|
+
/** Unwrap array type. */
|
|
229
|
+
type UnwrapArray<T>=T extends(infer U)[]?U:T extends readonly(infer U)[]?U:T;
|
|
230
|
+
/** Force symbol key to be deep required. */
|
|
231
|
+
type IsOptionalKey<T,K extends keyof T>=Record<never,never>extends Pick<T,K>?true:false;
|
|
232
|
+
/** Returns numeric keys of an object. */
|
|
233
|
+
type NumericKeyOfHasOwnProp<Obj>=Extract<keyof Obj,number>;
|
|
234
|
+
/** Generate all nested keys of an object or array in dot/bracket notation.
|
|
235
|
+
*
|
|
236
|
+
* Example:
|
|
237
|
+
* ```ts
|
|
238
|
+
* type Keys = NestedKeyOfHasOwnProp<{ users: { name: string }[] }>
|
|
239
|
+
* // Keys = "users" | "users.[number]" | "users.[number].name"
|
|
240
|
+
* ```
|
|
241
|
+
*/
|
|
242
|
+
type NestedKeyOfHasOwnProp<T>=T extends readonly(infer U)[]?`[${number}]`|`[${number}].${NestedKeyOfHasOwnProp<U>}`:T extends object?{[K in keyof T &(string|number)]:K extends string|number?NonNullable<T[K]>extends readonly unknown[]?`${K}`|`${K}.[${ArrayIndex}]`|`${K}.[${ArrayIndex}].${NestedKeyOfHasOwnProp<UnwrapArray<T[K]>>}`:NonNullable<T[K]>extends object?`${K}`|`${K}.${NestedKeyOfHasOwnProp<NonNullable<T[K]>>}`:`${K}`:never;}[keyof T &(string|number)]:never;
|
|
243
|
+
/** Apply discard rules to the last key of a path.
|
|
244
|
+
*
|
|
245
|
+
* Rules:
|
|
246
|
+
* - If discardUndefined=true -> remove `undefined` from value
|
|
247
|
+
* - If discardNull=true -> remove `null` from value
|
|
248
|
+
*
|
|
249
|
+
* Order: first strip undefined (if requested), then strip null (if requested)
|
|
250
|
+
*/
|
|
251
|
+
type ApplyLastRulesHasOwnProp<V,DiscardU extends boolean,DiscardN extends boolean>=DiscardU extends true?DiscardN extends true?NonNull<NonUndef<V>>:NonUndef<V>:DiscardN extends true?NonNull<V>:V|Extract<V,undefined>;
|
|
252
|
+
/** Force an array index N to type U. */
|
|
253
|
+
type RefineArrayAtIndex<T extends readonly unknown[],N extends number,U>=T &{[K in N]:U;};
|
|
254
|
+
/** Narrow object/array type based on a path string.
|
|
255
|
+
*
|
|
256
|
+
* @template T - object type to narrow
|
|
257
|
+
* @template P - path string like "user.addresses.[2].zip"
|
|
258
|
+
* @template DU - discard undefined
|
|
259
|
+
* @template DN - discard null
|
|
260
|
+
*/
|
|
261
|
+
type NarrowByPathHasOwnProp<T,P extends string,DU extends boolean=true,DN extends boolean=false>=P extends`${infer Head}.${infer Rest}`?Head extends`[${infer N extends number}]`?T extends readonly(infer U)[]?RefineArrayAtIndex<T,N,NarrowByPathHasOwnProp<U,Rest,DU,DN>>:T:Head extends keyof T?Rest extends`[${infer M extends number}]${infer R}`?M extends R?{[K in keyof T]-?:NarrowByPathHasOwnProp<EffectiveDiscardUndefined<DU>extends true?NonUndef<T[K]>:EffectiveDiscardNull<DN>extends true?NonNull<T[K]>:T[K],Rest,DU,DN>;}:EffectiveDiscardUndefined<DU>extends true?{[K in keyof T]-?:K extends Head?Exclude<NarrowByPathHasOwnProp<EffectiveDiscardNull<DN>extends true?Exclude<T[K],null>:EffectiveDiscardUndefined<DU>extends true?Exclude<T[K],undefined>:T[K],Rest,DU,DN>,undefined>:EffectiveDiscardNull<DN>extends true?Exclude<T[K],null>:EffectiveDiscardUndefined<DU>extends true?Exclude<T[K],undefined>:T[K];}:{[K in keyof T]:K extends Head?NarrowByPathHasOwnProp<EffectiveDiscardNull<DN>extends true?Exclude<T[K],null>:EffectiveDiscardUndefined<DU>extends true?Exclude<T[K],undefined>:T[K],Rest,DU,DN>:EffectiveDiscardNull<DN>extends true?Exclude<T[K],null>:EffectiveDiscardUndefined<DU>extends true?Exclude<T[K],undefined>:T[K];}:{[K in keyof T]:K extends Head?NarrowByPathHasOwnProp<NonNullable<T[K]>,Rest,DU,DN>:T[K];}&{[K in Head]-?:NarrowByPathHasOwnProp<NonNullable<T[K]>,Rest,DU,DN>;}:T:P extends`[${infer N extends number}]`?T extends readonly(infer U)[]?RefineArrayAtIndex<T,N,ApplyLastRulesHasOwnProp<NonNullable<U>,DU,DN>>:T:P extends keyof T?DU extends true?{[K in keyof T]:K extends P?ApplyLastRulesHasOwnProp<T[K],DU,DN>:T[K];}&{[K in P]-?:ApplyLastRulesHasOwnProp<T[P],DU,DN>;}:{[K in keyof T]:K extends P?ApplyLastRulesHasOwnProp<T[K],DU,DN>:T[K];}:T;
|
|
262
|
+
/** Expand an array/string/function into a nested type according to a dot/bracket path. */
|
|
263
|
+
type SmartDetectStringHasOwnProp<Obj extends string|undefined|null,Key extends string|number>=Obj extends undefined?undefined:Obj extends null?null:IsPositive<ParseNumber<Key>>extends true?Extends<IsStringLiteral<Obj>,true>extends true?CharAt<Exclude<Obj,null|undefined>,ParseNumber<Key>>:string|undefined|null:IsPositive<ParseNumber<Key>>extends true?string|undefined|null:AnyString|undefined|null;type SmartDetectArrayFuncHasOwnProp<Obj extends unknown[]|AnyFunction,Key extends PropertyKey>=Prettify<Obj & DotToNestedSpecialSmartDetect<Key>&{length:number;},{recursive:false;}>;
|
|
264
|
+
/** Smartly detect nested path keys of an unknown object or function, falls-back to inferred nested structure when path is not valid. */
|
|
265
|
+
type SmartDetectUnknownKeyHasOwnProp<Obj extends unknown|AnyFunction,Key extends PropertyKey,DiscardUndefined extends boolean=true,DiscardNull extends boolean=false>=Trim<Key>extends""?Obj:Prettify<Obj &(Key extends NestedKeyOfHasOwnProp<Obj>?GuardedHasOwnProp<Obj,Key,DiscardUndefined,DiscardNull>:DotToNestedSpecialSmartDetect<Key>),{recursive:true;}>;
|
|
266
|
+
/** Convert dot/bracket path string to nested object type with leaf value.
|
|
267
|
+
* Path not found in object key → return unknown.
|
|
268
|
+
*/
|
|
269
|
+
type DotToNestedSpecialSmartDetect<Path extends PropertyKey,Value=unknown>=IsEmptyString<Extract<Path,string>>extends true?undefined:Path extends`${infer Head}.${infer Rest}`?Head extends`[${number}]`?DotToNestedSpecialSmartDetect<Rest,Value>[]:{[Key in Head]:DotToNestedSpecialSmartDetect<Rest,Value>;}:Path extends`[${number}]`?Value[]:{[Key in Path]:Value;};
|
|
270
|
+
/** Guarded wrapper for `NarrowByPathHasOwnProp` with `Prettify`. */
|
|
271
|
+
type GuardedHasOwnProp<Obj,Key extends NestedKeyOfHasOwnProp<Obj>,DiscardUndefined extends boolean|undefined,DiscardNull extends boolean|undefined>=Prettify<Obj & NarrowByPathHasOwnProp<Obj,Key & string,EffectiveDiscardUndefined<DiscardUndefined>,EffectiveDiscardNull<DiscardNull>>,{recursive:true;}>;
|
|
272
|
+
/** Make a specific symbol key deeply required in an object symbols.
|
|
273
|
+
*
|
|
274
|
+
* Used internally to enforce stronger type narrowing.
|
|
275
|
+
*/
|
|
276
|
+
type DeepRequiredSymbolHasOwnProp<Obj,Sym extends symbol,DU extends boolean=true,DN extends boolean=false>=Prettify<Obj &({[K in keyof Obj & Sym as DU extends true?K:never]-?:DN extends true?NonNull<NonUndef<Obj[K]>>:NonUndef<Obj[K]>;}&{[K in keyof Obj & Sym as DU extends true?never:K]?:DN extends true?NonNull<Obj[K]>:Obj[K];}),{recursive:true;}>;
|
|
277
|
+
/** Apply discard rules to numeric keys in an object type.
|
|
278
|
+
*
|
|
279
|
+
* - If `discardUndefined = true` → undefined removed, key required
|
|
280
|
+
* - If `discardNull = true` → null removed
|
|
281
|
+
*/
|
|
282
|
+
type NumericKeyHasOwnPropMapped<Obj extends object,K extends NumericKeyOfHasOwnProp<Obj>,DU extends boolean,DN extends boolean>=Prettify<Obj &(IsOptionalKey<Obj,K>extends true?{[P in K]?:DN extends true?NonNull<Obj[K]>:Obj[K];}&(DU extends true?{[P in K]-?:NonUndef<Obj[K]>;}:Record<never,never>):{[P in K]-?:DN extends true?NonNull<Obj[K]>:Obj[K];}&(DU extends true?{[P in K]-?:NonUndef<Obj[K]>;}:Record<never,never>)),{recursive:true;}>;
|
|
283
|
+
/** Options to control `hasOwnProp` behavior. */
|
|
284
|
+
type HasOwnPropOptions<DiscardUndefined extends boolean=true,DiscardNull extends boolean=false>={
|
|
285
|
+
/**
|
|
286
|
+
* If `true` (default), properties with `undefined` values are treated as non-existent.
|
|
287
|
+
*
|
|
288
|
+
* **Effects:**
|
|
289
|
+
* - **Runtime:** `hasOwnProp(obj, key)` returns `false` if the property exists but its value is `undefined`.
|
|
290
|
+
* - **TypeScript narrowing:** The property's type is narrowed to exclude `undefined`.
|
|
291
|
+
*
|
|
292
|
+
* **Example:**
|
|
293
|
+
* ```ts
|
|
294
|
+
* const obj = { a: undefined, b: 123 };
|
|
295
|
+
* hasOwnProp(obj, "a"); // false
|
|
296
|
+
* hasOwnProp(obj, "a", { discardUndefined: false }); // true
|
|
297
|
+
* ```
|
|
298
|
+
*/
|
|
299
|
+
discardUndefined?:DiscardUndefined;
|
|
300
|
+
/**
|
|
301
|
+
* If `true` (default: `false`), properties with `null` values are treated as non-existent.
|
|
302
|
+
*
|
|
303
|
+
* **Effects:**
|
|
304
|
+
* - **Runtime:** `hasOwnProp(obj, key)` returns `false` if the property exists but its value is `null`.
|
|
305
|
+
* - **TypeScript narrowing:** The property's type is narrowed to exclude `null`.
|
|
306
|
+
*
|
|
307
|
+
* **Example:**
|
|
308
|
+
* ```ts
|
|
309
|
+
* const obj = { a: null, b: 123 };
|
|
310
|
+
* hasOwnProp(obj, "a"); // true (default discardNull = false)
|
|
311
|
+
* hasOwnProp(obj, "a", { discardNull: true }); // false
|
|
312
|
+
* ```
|
|
313
|
+
*/
|
|
314
|
+
discardNull?:DiscardNull;};
|
|
315
|
+
/** -------------------------------------------------------
|
|
316
|
+
* * ***A **type-safe** replacement for `Object.prototype.hasOwnProperty`
|
|
317
|
+
* with runtime validation and **TypeScript-aware type narrowing**.***
|
|
318
|
+
* -------------------------------------------------------
|
|
319
|
+
*
|
|
320
|
+
* ---
|
|
321
|
+
* #### Supported Targets
|
|
322
|
+
* - **Plain objects** ➔ `{ foo: "bar" }`
|
|
323
|
+
* - **Arrays** ➔ `[ { id: 1 }, { id: 2 } ]`
|
|
324
|
+
* - **Strings** ➔ `"hello"` (as array-like objects with `.length`, index, etc.)
|
|
325
|
+
* - **Functions** ➔ callable objects with extra props
|
|
326
|
+
* - **Symbols** ➔ own property symbols
|
|
327
|
+
*
|
|
328
|
+
* ---
|
|
329
|
+
* #### Key Advantages over `in` or `obj.hasOwnProperty(key)`
|
|
330
|
+
* - Supports **dot/bracket path notation** (e.g. `"user.address.city"`, `"addresses[0].zip"`)
|
|
331
|
+
* - Handles **symbol** keys safely
|
|
332
|
+
* - **Narrows** the type of `obj` in TypeScript (stronger type safety)
|
|
333
|
+
* - Configurable handling of **`undefined`** and **`null`**
|
|
334
|
+
*
|
|
335
|
+
* ---
|
|
336
|
+
* #### Runtime Behavior
|
|
337
|
+
* ✅ Returns `true` if:
|
|
338
|
+
* - `obj` is an object/array/string/function **and**
|
|
339
|
+
* - the property exists **and**
|
|
340
|
+
* - it passes the `options` checks
|
|
341
|
+
*
|
|
342
|
+
* ❌ Returns `false` if:
|
|
343
|
+
* - `obj` is not a valid type
|
|
344
|
+
* - the property does not exist
|
|
345
|
+
* - the value is `undefined` and `discardUndefined: true` (default)
|
|
346
|
+
* - the value is `null` and `discardNull: true`
|
|
347
|
+
* - the `key` (after trimming) is an **empty string** ➔ treated as **invalid**
|
|
348
|
+
*
|
|
349
|
+
* ---
|
|
350
|
+
* #### TypeScript Behavior
|
|
351
|
+
* Inside an `if (hasOwnProp(...)) {}` block:
|
|
352
|
+
* - The property is **guaranteed to exist**
|
|
353
|
+
* - Depending on `options`, the property type is narrowed to exclude
|
|
354
|
+
* `undefined` and/or `null`
|
|
355
|
+
*
|
|
356
|
+
* ---
|
|
357
|
+
* #### ⚠️ Caveats
|
|
358
|
+
* - **Empty keys are invalid**:
|
|
359
|
+
* - If the `key` string is empty (`""`) after trimming whitespace or other characters,
|
|
360
|
+
* it will **not** be considered a valid property and always returns `false`.
|
|
361
|
+
*
|
|
362
|
+
* - **Arrays are limited by TypeScript inference**:
|
|
363
|
+
* - Checking index `[0]` only narrows **that specific index**, not the rest.
|
|
364
|
+
* - Example:
|
|
365
|
+
* - `hasOwnProp(users, "[0].id")` does **not** imply `users[1].id` exists.
|
|
366
|
+
* - 👉 For different indices, use **optional chaining** (`users[1]?.id`).
|
|
367
|
+
*
|
|
368
|
+
* - **Autocomplete limitation for array indices**:
|
|
369
|
+
* - Autocompletion for `[index]` is only supported up to **25** (`[0]` ➔ `[24]`).
|
|
370
|
+
* - This limit is intentional for **performance and safety**:
|
|
371
|
+
* generating infinite union types for all possible indices would cause
|
|
372
|
+
* **TypeScript IntelliSense to hang or crash**.
|
|
373
|
+
* You can still check higher indices manually (e.g. `"[999].id"`),
|
|
374
|
+
* but they will not show up in IntelliSense suggestions.
|
|
375
|
+
*
|
|
376
|
+
* ---
|
|
377
|
+
* #### Options
|
|
378
|
+
* @param options.discardUndefined - Default `true`.
|
|
379
|
+
* If `true`, properties with `undefined` values are treated as **missing**.
|
|
380
|
+
*
|
|
381
|
+
* @param options.discardNull - Default `false`.
|
|
382
|
+
* If `true`, properties with `null` values are treated as **missing**.
|
|
383
|
+
*
|
|
384
|
+
* ---
|
|
385
|
+
* @example
|
|
386
|
+
*
|
|
387
|
+
* #### ✅ Objects
|
|
388
|
+
* ```ts
|
|
389
|
+
* const obj: { name?: string | null } = {};
|
|
390
|
+
*
|
|
391
|
+
* if (hasOwnProp(obj, "name")) {
|
|
392
|
+
* // obj is now ➔ { name: string | null }
|
|
393
|
+
* console.log(obj.name); // string | null
|
|
394
|
+
* }
|
|
395
|
+
*
|
|
396
|
+
* if (hasOwnProp(obj, "name", { discardUndefined: true, discardNull: true })) {
|
|
397
|
+
* // obj is now ➔ { name: string }
|
|
398
|
+
* console.log(obj.name.toUpperCase()); // safe
|
|
399
|
+
* }
|
|
400
|
+
* ```
|
|
401
|
+
*
|
|
402
|
+
* #### ✅ Arrays
|
|
403
|
+
* ```ts
|
|
404
|
+
* const users = [{ id: 1 }, { id: 2 }];
|
|
405
|
+
*
|
|
406
|
+
* if (hasOwnProp(users, "[1].id")) {
|
|
407
|
+
* // ➔ users[1].id is guaranteed to exist
|
|
408
|
+
* console.log(users[1].id); // number
|
|
409
|
+
* }
|
|
410
|
+
*
|
|
411
|
+
* // ⚠️ Caveat: narrowing only applies to checked index
|
|
412
|
+
* if (hasOwnProp(users, "[0].id")) {
|
|
413
|
+
* console.log(users[0].id); // ✅ safe
|
|
414
|
+
* console.log(users[1].id); // ❌ not guaranteed!
|
|
415
|
+
* }
|
|
416
|
+
*
|
|
417
|
+
* // 👉 Solution: optional chaining
|
|
418
|
+
* console.log(users[1]?.id); // ➔ safe, even without narrowing
|
|
419
|
+
* ```
|
|
420
|
+
*
|
|
421
|
+
* #### ✅ Symbols
|
|
422
|
+
* ```ts
|
|
423
|
+
* const secret = Symbol("secret");
|
|
424
|
+
* const obj2 = { [secret]: 42 };
|
|
425
|
+
*
|
|
426
|
+
* if (hasOwnProp(obj2, secret)) {
|
|
427
|
+
* console.log(obj2[secret] + 1); // ➔ 43
|
|
428
|
+
* }
|
|
429
|
+
* ```
|
|
430
|
+
*
|
|
431
|
+
* #### ✅ Strings
|
|
432
|
+
* ```ts
|
|
433
|
+
* if (hasOwnProp("hello", "length")) {
|
|
434
|
+
* console.log("hello".length); // ➔ 5
|
|
435
|
+
* }
|
|
436
|
+
*
|
|
437
|
+
* if (hasOwnProp("hello", 1)) {
|
|
438
|
+
* console.log("hello"[1]); // ➔ "e"
|
|
439
|
+
* }
|
|
440
|
+
* ```
|
|
441
|
+
*
|
|
442
|
+
*
|
|
443
|
+
* #### ✅ Functions
|
|
444
|
+
* ```ts
|
|
445
|
+
* function fn() {}
|
|
446
|
+
* fn.extra = 123;
|
|
447
|
+
*
|
|
448
|
+
* if (hasOwnProp(fn, "extra")) {
|
|
449
|
+
* console.log(fn.extra); // ➔ 123
|
|
450
|
+
* }
|
|
451
|
+
* ```
|
|
452
|
+
*
|
|
453
|
+
* #### ❌ Empty key
|
|
454
|
+
* ```ts
|
|
455
|
+
* const obj = { a: 1 };
|
|
456
|
+
*
|
|
457
|
+
* hasOwnProp(obj, ""); // ➔ false (invalid key)
|
|
458
|
+
* hasOwnProp(obj, " "); // ➔ false (trimmed to empty)
|
|
459
|
+
* ```
|
|
460
|
+
*/
|
|
461
|
+
declare function hasOwnProp<Obj>(obj:IsAny<Obj>extends true?Obj:never,key:PropertyKey,options?:HasOwnPropOptions<boolean,boolean>
|
|
462
|
+
/** @ts-expect-error we force `any` to `unknown` at result */
|
|
463
|
+
):obj is unknown;declare function hasOwnProp<Obj extends null|undefined>(obj:Obj,key:PropertyKey,options?:HasOwnPropOptions<boolean,boolean>):false;declare function hasOwnProp<Obj extends object|AnyFunction,Key extends NestedKeyOfHasOwnProp<Obj>,DiscardUndefined extends boolean=true,DiscardNull extends boolean=false>(obj:Obj|null|undefined,key:Key,options?:HasOwnPropOptions<DiscardUndefined,DiscardNull>
|
|
464
|
+
/** @ts-expect-error we force to override recursive type result */
|
|
465
|
+
):obj is GuardedHasOwnProp<Obj,Key,DiscardUndefined,DiscardNull>;declare function hasOwnProp<Obj extends object,Num extends NumericKeyOfHasOwnProp<Obj>,DiscardUndefined extends boolean=true,DiscardNull extends boolean=false>(obj:Obj|null|undefined,key:Num,options?:HasOwnPropOptions<DiscardUndefined,DiscardNull>
|
|
466
|
+
/** @ts-expect-error we force to override recursive type result */
|
|
467
|
+
):obj is NumericKeyHasOwnPropMapped<Obj,Num,DiscardUndefined,DiscardNull>;declare function hasOwnProp<Obj extends object|AnyFunction,Sym extends symbol,DiscardUndefined extends boolean=true,DiscardNull extends boolean=false>(obj:Obj|null|undefined,key:Sym,options?:HasOwnPropOptions<DiscardUndefined,DiscardNull>
|
|
468
|
+
/** @ts-expect-error we force to override recursive type result */
|
|
469
|
+
):obj is DeepRequiredSymbolHasOwnProp<Obj,Sym,DiscardUndefined,DiscardNull>;declare function hasOwnProp<Obj extends string|null|undefined,Key extends string|number>(obj:Obj|null|undefined,key:Key,options?:HasOwnPropOptions<boolean,boolean>
|
|
470
|
+
/** @ts-expect-error we force to override recursive type result */
|
|
471
|
+
):obj is IsStringLiteral<SmartDetectStringHasOwnProp<Obj,Key>>extends true?AnyString|SmartDetectStringHasOwnProp<Obj,Key>:SmartDetectStringHasOwnProp<Obj,Key>;declare function hasOwnProp<Obj extends unknown[]|AnyFunction,Key extends PropertyKey>(obj:Obj,key:Key,options?:HasOwnPropOptions<boolean,boolean>):obj is SmartDetectArrayFuncHasOwnProp<Obj,Key>;declare function hasOwnProp<Obj extends unknown|AnyFunction,Key extends PropertyKey,DiscardUndefined extends boolean=true,DiscardNull extends boolean=false>(obj:Obj,key:Key|"length"|(IsPlainObjectResult<Obj>extends never?never:keyof Obj),options?:HasOwnPropOptions<DiscardUndefined,DiscardNull>
|
|
472
|
+
/** @ts-expect-error we force to override recursive type result */
|
|
473
|
+
):obj is SmartDetectUnknownKeyHasOwnProp<Obj,Key,DiscardUndefined,DiscardNull>;
|
|
474
|
+
/** -------------------
|
|
475
|
+
* * ***Type guard: `isArguments`.***
|
|
476
|
+
* -------------------
|
|
477
|
+
* @description Checks if `value` is likely an `arguments` object.
|
|
478
|
+
*
|
|
479
|
+
* @param {*} value The value to check.
|
|
480
|
+
* @returns {boolean} Returns `true` if `value` is an **[IArguments](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Functions/arguments)** object,
|
|
481
|
+
* else `false`.
|
|
482
|
+
* @example
|
|
483
|
+
* isArguments(function() { return arguments; }());
|
|
484
|
+
* // ➔ true
|
|
485
|
+
* isArguments([1, 2, 3]);
|
|
486
|
+
* // ➔ false
|
|
487
|
+
*/
|
|
488
|
+
declare const isArguments:(value:unknown)=>value is IArguments;
|
|
489
|
+
/** @deprecated bugs */
|
|
490
|
+
type IsArrayResult<T>=IsUnknown<T>extends true?unknown[] & T:IsNever<T>extends true?[]:IsReadonlyArray<T>extends true?T:IsArray<T>extends true?T:unknown[];
|
|
491
|
+
/** ----------------------------------------------------------
|
|
492
|
+
* * ***Type guard: `isArray`.***
|
|
493
|
+
* ----------------------------------------------------------
|
|
494
|
+
* @description Checks if a value is an [`Array`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array).
|
|
495
|
+
*
|
|
496
|
+
* - Uses **[`Array.isArray`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/isArray)** for reliable and safe type checking.
|
|
497
|
+
* - Supports TypeScript **type narrowing** using `value is T[]`.
|
|
498
|
+
* - Handles edge cases like `null`, `undefined`, and non-array objects.
|
|
499
|
+
*
|
|
500
|
+
* @template T - The expected type of array elements.
|
|
501
|
+
* @param {*} value - The value to check.
|
|
502
|
+
* @returns {boolean} Returns `true` if the value is an `array`, otherwise `false`.
|
|
503
|
+
* @example
|
|
504
|
+
* isArray([1, 2, 3]);
|
|
505
|
+
* // ➔ true
|
|
506
|
+
* isArray([]);
|
|
507
|
+
* // ➔ true
|
|
508
|
+
* isArray("hello");
|
|
509
|
+
* // ➔ false
|
|
510
|
+
* isArray({ key: "value" });
|
|
511
|
+
* // ➔ false
|
|
512
|
+
* isArray(null);
|
|
513
|
+
* // ➔ false
|
|
514
|
+
* isArray(undefined);
|
|
515
|
+
* // ➔ false
|
|
516
|
+
*/
|
|
517
|
+
declare function isArray<T extends unknown[]>(value:T):value is Extract<T,unknown[]>;declare function isArray<T extends readonly unknown[]>(value:T):value is Extract<T,readonly unknown[]>;declare function isArray(value:unknown):value is unknown[];
|
|
518
|
+
/** ----------------------------------------------------
|
|
519
|
+
* * ***Type guard: `isArrayBuffer`.***
|
|
520
|
+
* ----------------------------------------------------
|
|
521
|
+
* @description Checks if `value` is classified as an `ArrayBuffer` object.
|
|
522
|
+
* @param {*} value The value to check.
|
|
523
|
+
* @returns {boolean} Returns `true` if `value` is instance of **[ArrayBuffer](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer)**, else `false`.
|
|
524
|
+
* @example
|
|
525
|
+
* isArrayBuffer(new ArrayBuffer(2));
|
|
526
|
+
* // ➔ true
|
|
527
|
+
* isArrayBuffer(new Array(2));
|
|
528
|
+
* // ➔ false
|
|
529
|
+
*/
|
|
530
|
+
declare function isArrayBuffer(value:unknown):value is ArrayBuffer;
|
|
531
|
+
/** ----------------------------------------------------
|
|
532
|
+
* * ***Type guard: `isArrayLike`.***
|
|
533
|
+
* ----------------------------------------------------
|
|
534
|
+
* @description Checks if `value` is array-like. A value is considered array-like if it's
|
|
535
|
+
* not a function and has a `value.length` that's an integer greater than or
|
|
536
|
+
* equal to `0` and less than or equal to `Number.MAX_SAFE_INTEGER`.
|
|
537
|
+
*
|
|
538
|
+
* @template T - The type of the value being checked.
|
|
539
|
+
* @param {*} value The value to check.
|
|
540
|
+
* @returns {boolean} Returns `true` if `value` is array-like, else `false`.
|
|
541
|
+
* @example
|
|
542
|
+
* isArrayLike([1, 2, 3]);
|
|
543
|
+
* // ➔ true
|
|
544
|
+
* isArrayLike(document.body.children);
|
|
545
|
+
* // ➔ true
|
|
546
|
+
* isArrayLike(noop);
|
|
547
|
+
* // ➔ false
|
|
548
|
+
* isArrayLike('abc');
|
|
549
|
+
* // ➔ false
|
|
550
|
+
*/
|
|
551
|
+
declare function isArrayLike<T extends{__anyHack:unknown;}>(value:T):boolean;declare function isArrayLike(value:AnyFunction|null|undefined):value is never;declare function isArrayLike(value:unknown):value is{length:number;};
|
|
552
|
+
/** ----------------------------------------------------
|
|
553
|
+
* * ***Type guard: `isArrayLikeObject`.***
|
|
554
|
+
* ----------------------------------------------------
|
|
555
|
+
* @description This method is like **{@link isArrayLike}** except that it also checks if `value` is an object.
|
|
556
|
+
* @template T - The type of the value being checked.
|
|
557
|
+
* @param {*} value The value to check.
|
|
558
|
+
* @returns {boolean} Returns `true` if `value` is `array-like object`, else `false`.
|
|
559
|
+
* @example
|
|
560
|
+
* isArrayLikeObject([1, 2, 3]);
|
|
561
|
+
* // ➔ true
|
|
562
|
+
* isArrayLikeObject(document.body.children);
|
|
563
|
+
* // ➔ true
|
|
564
|
+
* isArrayLikeObject('abc');
|
|
565
|
+
* // ➔ false
|
|
566
|
+
* isArrayLikeObject(noop);
|
|
567
|
+
* // ➔ false
|
|
568
|
+
*/
|
|
569
|
+
declare function isArrayLikeObject<T extends{__anyHack:unknown;}>(value:T):boolean;declare function isArrayLikeObject(value:AnyFunction|string|boolean|number|null|undefined):value is never;declare function isArrayLikeObject(value:unknown):value is object &{length:number;};
|
|
570
|
+
/** ----------------------------------------------------------
|
|
571
|
+
* * ***Type guard: `isBigInt`.***
|
|
572
|
+
* ----------------------------------------------------------
|
|
573
|
+
* @description Checks if a value is of type bigint.
|
|
574
|
+
* - Uses `typeof value === "bigint"` for strict type checking.
|
|
575
|
+
* - Supports TypeScript type narrowing with `value is bigint`.
|
|
576
|
+
* - Returns `false` for `BigInt` object (object-wrapped), e.g. `Object(BigInt(123))`.
|
|
577
|
+
*
|
|
578
|
+
* @param {*} value - The value to check.
|
|
579
|
+
* @returns {boolean} Return `true` if value is a primitive **[`BigInt`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/BigInt)**.
|
|
580
|
+
* @example
|
|
581
|
+
* isBigInt(123n);
|
|
582
|
+
* // ➔ true
|
|
583
|
+
* isBigInt(BigInt(123));
|
|
584
|
+
* // ➔ true
|
|
585
|
+
* isBigInt("123");
|
|
586
|
+
* // ➔ false
|
|
587
|
+
* isBigInt(Object(BigInt(1)));
|
|
588
|
+
* // ➔ false
|
|
589
|
+
*/
|
|
590
|
+
declare const isBigInt:(value:unknown)=>value is bigint;
|
|
591
|
+
/** ----------------------------------------------------------
|
|
592
|
+
* * ***Type guard: `isBoolean`.***
|
|
593
|
+
* ----------------------------------------------------------
|
|
594
|
+
* @description Checks if a value is of type boolean.
|
|
595
|
+
* @param {*} value - The value to check.
|
|
596
|
+
* @returns {boolean} Returns `true` if the value is a **[`boolean`](https://developer.mozilla.org/en-US/docs/Glossary/Boolean/JavaScript)**, otherwise `false`.
|
|
597
|
+
* @example
|
|
598
|
+
* isBoolean(true); // ➔ true
|
|
599
|
+
* isBoolean(false); // ➔ true
|
|
600
|
+
* isBoolean("true"); // ➔ false
|
|
601
|
+
*/
|
|
602
|
+
declare const isBoolean:(value:unknown)=>value is boolean;
|
|
603
|
+
/** ----------------------------------------------------
|
|
604
|
+
* * ***Type guard: `isBuffer`.***
|
|
605
|
+
* ----------------------------------------------------------
|
|
606
|
+
* @description Checks if a value is a **Node.js Buffer** instance.
|
|
607
|
+
* @param {*} value The value to check.
|
|
608
|
+
* @returns {boolean} Returns `true` if `value` is a **{@link Buffer}**, else `false`.
|
|
609
|
+
* @example
|
|
610
|
+
* isBuffer(new Buffer(2));
|
|
611
|
+
* // ➔ true
|
|
612
|
+
* isBuffer(Buffer.alloc(10));
|
|
613
|
+
* // ➔ true
|
|
614
|
+
* isBuffer(Buffer.from('foo'));
|
|
615
|
+
* // ➔ true
|
|
616
|
+
* isBuffer([]);
|
|
617
|
+
* // ➔ false
|
|
618
|
+
* isBuffer('a string');
|
|
619
|
+
* // ➔ false
|
|
620
|
+
* isBuffer(new Uint8Array(1024));
|
|
621
|
+
* // ➔ false
|
|
622
|
+
*/
|
|
623
|
+
declare const isBuffer:(value:unknown)=>value is Buffer;
|
|
624
|
+
/** -----------------------------------------------------------
|
|
625
|
+
* * ***Checks whether a value looks like a currency or number string.***
|
|
626
|
+
* -----------------------------------------------------------
|
|
627
|
+
* Determines if the given `input` can be interpreted as a currency-like number,
|
|
628
|
+
* using the same **multi-locale parsing logic** as **{@link parseCurrencyString}**.
|
|
629
|
+
*
|
|
630
|
+
* Highlights:
|
|
631
|
+
* - Supports strings or numbers like:
|
|
632
|
+
* - "15.000,10" (European)
|
|
633
|
+
* - "15,000.10" (US)
|
|
634
|
+
* - "15'000.10" (Swiss)
|
|
635
|
+
* - "15 000,10" (French)
|
|
636
|
+
* - "Rp 15.000,10" or "$15,000.10"
|
|
637
|
+
* - Also accepts simple numbers (15300.95).
|
|
638
|
+
*
|
|
639
|
+
* Uses the same core logic as **{@link parseCurrencyString}** but
|
|
640
|
+
* just checks if a final parsed float is sensible.
|
|
641
|
+
*
|
|
642
|
+
* @param {*} input - The input value to check.
|
|
643
|
+
*
|
|
644
|
+
* @returns {boolean} Return `true` if it can be reasonably parsed into a currency-like number, `false` otherwise.
|
|
645
|
+
*
|
|
646
|
+
* @example
|
|
647
|
+
* isCurrencyLike(15300.95);
|
|
648
|
+
* // ➔ true
|
|
649
|
+
* isCurrencyLike("$15,000.10");
|
|
650
|
+
* // ➔ true
|
|
651
|
+
* isCurrencyLike("(15'000.10)");
|
|
652
|
+
* // ➔ true
|
|
653
|
+
* isCurrencyLike("Rp 15.000,10");
|
|
654
|
+
* // ➔ true
|
|
655
|
+
* isCurrencyLike("");
|
|
656
|
+
* // ➔ false
|
|
657
|
+
* isCurrencyLike("abc");
|
|
658
|
+
* // ➔ false
|
|
659
|
+
*/
|
|
660
|
+
declare const isCurrencyLike:(input:unknown)=>boolean;
|
|
661
|
+
/** ----------------------------------------------------------
|
|
662
|
+
* * ***Type guard: `isDate`.***
|
|
663
|
+
* ----------------------------------------------------------
|
|
664
|
+
* @description Determines whether the given `value` is a real, valid JavaScript **[`Date`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date)** object.
|
|
665
|
+
* - Checks if value is an instance of `Date`.
|
|
666
|
+
* - Ensures the date is valid (`!isNaN(date.getTime())`).
|
|
667
|
+
* - Returns false for strings or invalid date objects.
|
|
668
|
+
*
|
|
669
|
+
* @param {*} value - The value to check.
|
|
670
|
+
* @returns {boolean} Return `true` if value is a valid Date object.
|
|
671
|
+
* @example
|
|
672
|
+
* isDate(new Date());
|
|
673
|
+
* // ➔ true
|
|
674
|
+
* isDate(new Date("invalid"));
|
|
675
|
+
* // ➔ false
|
|
676
|
+
* isDate("2024-01-01");
|
|
677
|
+
* // ➔ false
|
|
678
|
+
*/
|
|
679
|
+
declare const isDate:(value:unknown)=>value is Date;
|
|
680
|
+
/** ----------------------------------------------------------
|
|
681
|
+
* * ***Performs a deep equality check between two values.***
|
|
682
|
+
* ----------------------------------------------------------
|
|
683
|
+
* - Compares nested arrays, objects, Dates, RegExp, NaN, Symbols, Set, and Map.
|
|
684
|
+
* - Handles special cases:
|
|
685
|
+
* - `NaN` is considered equal to `NaN`.
|
|
686
|
+
* - `Date` objects are equal if `.getTime()` is equal.
|
|
687
|
+
* - `RegExp` objects are equal if `.toString()` is equal.
|
|
688
|
+
* - `Symbol("x")` and `Symbol("x")` are treated equal if `.toString()` matches.
|
|
689
|
+
* - `Set` and `Map` are deeply compared by content (order-insensitive).
|
|
690
|
+
* - Does not support circular references.
|
|
691
|
+
*
|
|
692
|
+
* @param {*} a - First value to compare.
|
|
693
|
+
* @param {*} b - Second value to compare.
|
|
694
|
+
* @returns {boolean} `true` if both values are deeply equal, otherwise `false`.
|
|
695
|
+
* @example
|
|
696
|
+
* // ✅ Primitives
|
|
697
|
+
* isDeepEqual(1, 1);
|
|
698
|
+
* // ➔ true
|
|
699
|
+
* isDeepEqual(NaN, NaN);
|
|
700
|
+
* // ➔ true
|
|
701
|
+
* isDeepEqual("hello", "world");
|
|
702
|
+
* // ➔ false
|
|
703
|
+
*
|
|
704
|
+
* // ✅ Objects
|
|
705
|
+
* isDeepEqual({ x: 1 }, { x: 1 });
|
|
706
|
+
* // ➔ true
|
|
707
|
+
* isDeepEqual({ x: 1 }, { y: 1 });
|
|
708
|
+
* // ➔ false
|
|
709
|
+
*
|
|
710
|
+
* // ✅ Arrays
|
|
711
|
+
* isDeepEqual([1, 2], [1, 2]);
|
|
712
|
+
* // ➔ true
|
|
713
|
+
* isDeepEqual([1, 2], [2, 1]);
|
|
714
|
+
* // ➔ false
|
|
715
|
+
*
|
|
716
|
+
* // ✅ Dates
|
|
717
|
+
* isDeepEqual(new Date(123), new Date(123));
|
|
718
|
+
* // ➔ true
|
|
719
|
+
*
|
|
720
|
+
* // ✅ Sets
|
|
721
|
+
* isDeepEqual(new Set([1, 2]), new Set([2, 1]));
|
|
722
|
+
* // ➔ true
|
|
723
|
+
*
|
|
724
|
+
* // ✅ Maps
|
|
725
|
+
* isDeepEqual(new Map([["a", 1]]), new Map([["a", 1]]));
|
|
726
|
+
* // ➔ true
|
|
727
|
+
*
|
|
728
|
+
* // ❌ Different types
|
|
729
|
+
* isDeepEqual(1, "1");
|
|
730
|
+
* // ➔ false
|
|
731
|
+
*/
|
|
732
|
+
declare const isDeepEqual:(a:unknown,b:unknown)=>boolean;
|
|
733
|
+
/** ----------------------------------------------------
|
|
734
|
+
* * ***Type guard: `isElement`.***
|
|
735
|
+
* ----------------------------------------------------------
|
|
736
|
+
* @description Checks if `value` is likely a **[`DOM Element`](https://developer.mozilla.org/en-US/docs/Web/API/Element)**.
|
|
737
|
+
* @template T - The type of the value being checked.
|
|
738
|
+
* @param {*} value The value to check.
|
|
739
|
+
* @returns {boolean} Returns `true` if `value` is extends instance of **[`Element`](https://developer.mozilla.org/en-US/docs/Web/API/Element)**, else `false`.
|
|
740
|
+
* @example
|
|
741
|
+
* isElement(document.body);
|
|
742
|
+
* // ➔ true
|
|
743
|
+
* isElement(document.createElement("div"));
|
|
744
|
+
* // ➔ true
|
|
745
|
+
* isElement('<body>');
|
|
746
|
+
* // ➔ false
|
|
747
|
+
* isElement(document);
|
|
748
|
+
* // ➔ false
|
|
749
|
+
* isElement({ tagName: "DIV" });
|
|
750
|
+
* // ➔ false
|
|
751
|
+
*/
|
|
752
|
+
declare function isElement(value:[]):value is [];declare function isElement<T extends Element>(value:T):value is T;declare function isElement(value:unknown):value is Element;
|
|
753
|
+
/** ----------------------------------------------------
|
|
754
|
+
* * ***Utility: `isEmpty`.***
|
|
755
|
+
* ----------------------------------------------------------
|
|
756
|
+
* @description Checks if `value` is an empty object, collection, map, or set.
|
|
757
|
+
* - **Objects** are empty if they have no own enumerable string keyed properties.
|
|
758
|
+
* - **Array-like values** (arrays, strings, `arguments`, typed arrays, buffers) are empty if their `length` is `0`.
|
|
759
|
+
* - **Maps** and **Sets** are empty if their `size` is `0`.
|
|
760
|
+
* - **Booleans**, **numbers** (including `NaN`), **symbols**, and `null`/`undefined` are treated as empty.
|
|
761
|
+
* - **Functions** are considered empty if they have no own enumerable keys.
|
|
762
|
+
*
|
|
763
|
+
* **⚠️ Notes:** For More Strict, you can use **{@link isEmptyValue}**.
|
|
764
|
+
*
|
|
765
|
+
* @template T - The type of the value being checked.
|
|
766
|
+
* @param {*} value The value to check.
|
|
767
|
+
* @returns {boolean} Returns `true` if `value` is empty, else `false`.
|
|
768
|
+
* @example
|
|
769
|
+
* isEmpty(null);
|
|
770
|
+
* // ➔ true
|
|
771
|
+
* isEmpty(true);
|
|
772
|
+
* // ➔ true
|
|
773
|
+
* isEmpty(false);
|
|
774
|
+
* // ➔ true
|
|
775
|
+
* isEmpty(1);
|
|
776
|
+
* // ➔ true
|
|
777
|
+
* isEmpty(0);
|
|
778
|
+
* // ➔ true
|
|
779
|
+
* isEmpty(Symbol("x"));
|
|
780
|
+
* // ➔ true
|
|
781
|
+
* isEmpty(() => {});
|
|
782
|
+
* // ➔ true
|
|
783
|
+
* isEmpty("");
|
|
784
|
+
* // ➔ true
|
|
785
|
+
* isEmpty(" ");
|
|
786
|
+
* // ➔ false
|
|
787
|
+
* isEmpty([1, 2, 3]);
|
|
788
|
+
* // ➔ false
|
|
789
|
+
* isEmpty({ 'a': 1 });
|
|
790
|
+
* // ➔ false
|
|
791
|
+
*/
|
|
792
|
+
declare function isEmpty<T extends{__trapAny:any;}>(value?:T):boolean;declare function isEmpty(value:string):value is"";declare function isEmpty(value:Map<any,any>|Set<any>|List<any>|null|undefined):boolean;declare function isEmpty(value:object):boolean;declare function isEmpty<T extends object>(value:T|null|undefined):value is EmptyObjectOf<T>|null|undefined;declare function isEmpty(value:any):boolean;
|
|
793
|
+
/** ----------------------------------------------------------
|
|
794
|
+
* * ***Type guard: `isEmptyArray`.***
|
|
795
|
+
* ----------------------------------------------------------
|
|
796
|
+
* @description
|
|
797
|
+
* - Checks whether a given value is an empty array.
|
|
798
|
+
* - Non-array inputs are considered "empty" (defensive strategy).
|
|
799
|
+
*
|
|
800
|
+
* @param {*} [value] - The value to check.
|
|
801
|
+
* @returns {boolean} Returns `true` if it's not an array or an empty array.
|
|
802
|
+
* @example
|
|
803
|
+
* isEmptyArray([]); // ➔ true
|
|
804
|
+
* isEmptyArray([1, 2, 3]); // ➔ false
|
|
805
|
+
* isEmptyArray("not an array"); // ➔ true
|
|
806
|
+
* isEmptyArray(null); // ➔ true
|
|
807
|
+
* isEmptyArray(undefined); // ➔ true
|
|
808
|
+
*
|
|
809
|
+
* if (isEmptyArray(data.items)) {
|
|
810
|
+
* console.log("No items to display.");
|
|
811
|
+
* }
|
|
812
|
+
*/
|
|
813
|
+
declare const isEmptyArray:(value:unknown)=>boolean;
|
|
814
|
+
/** ----------------------------------------------------------
|
|
815
|
+
* * ***Predicate: `isEmptyDeep`.***
|
|
816
|
+
* ----------------------------------------------------------
|
|
817
|
+
* @description
|
|
818
|
+
* Recursively checks whether a value is **deeply empty**.
|
|
819
|
+
*
|
|
820
|
+
* - Returns `true` for:
|
|
821
|
+
* - Empty objects: `{}`
|
|
822
|
+
* - Empty arrays: `[]`
|
|
823
|
+
* - Nested empty structures: `{ a: [], b: {} }`
|
|
824
|
+
* - Falsy values (except numbers): `null`, `undefined`, `false`, `""`, `NaN`
|
|
825
|
+
*
|
|
826
|
+
* - Returns `false` for:
|
|
827
|
+
* - Non-zero numbers
|
|
828
|
+
* - Objects or arrays containing non-empty values
|
|
829
|
+
* - Non-empty strings, `true`, functions, symbols, etc.
|
|
830
|
+
*
|
|
831
|
+
* @param {*} value - The value to deeply check.
|
|
832
|
+
* @returns {boolean} `true` if the value is deeply empty, otherwise `false`.
|
|
833
|
+
* @example
|
|
834
|
+
* isEmptyDeep({});
|
|
835
|
+
* // ➔ true
|
|
836
|
+
* isEmptyDeep([]);
|
|
837
|
+
* // ➔ true
|
|
838
|
+
* isEmptyDeep({ a: {} });
|
|
839
|
+
* // ➔ true
|
|
840
|
+
* isEmptyDeep([[], {}]);
|
|
841
|
+
* // ➔ true
|
|
842
|
+
* isEmptyDeep({ a: [1] });
|
|
843
|
+
* // ➔ false
|
|
844
|
+
* isEmptyDeep([0]);
|
|
845
|
+
* // ➔ false
|
|
846
|
+
* isEmptyDeep("test");
|
|
847
|
+
* // ➔ false
|
|
848
|
+
* isEmptyDeep("");
|
|
849
|
+
* // ➔ true
|
|
850
|
+
* isEmptyDeep(0);
|
|
851
|
+
* // ➔ false
|
|
852
|
+
* isEmptyDeep(NaN);
|
|
853
|
+
* // ➔ true
|
|
854
|
+
*/
|
|
855
|
+
declare const isEmptyDeep:(value:unknown)=>boolean;type IsEmptyObjectOptions={
|
|
856
|
+
/** Whether to check for symbol properties in addition to string keys.
|
|
857
|
+
*
|
|
858
|
+
* DefaultValue: `false`.
|
|
859
|
+
*
|
|
860
|
+
* @default false
|
|
861
|
+
*/
|
|
862
|
+
checkSymbols?:boolean;};
|
|
863
|
+
/** ----------------------------------------------------------
|
|
864
|
+
* * ***Predicate: `isEmptyObject`.***
|
|
865
|
+
* ----------------------------------------------------------
|
|
866
|
+
* @description Checks if a value is a plain object with **no own enumerable string-key properties**,
|
|
867
|
+
* and optionally **no own enumerable symbol-key properties** when `checkSymbols` is `true`.
|
|
868
|
+
*
|
|
869
|
+
* - If the value is **not an object** (e.g. `null`, array, primitive), it is considered empty.
|
|
870
|
+
* - If `options.checkSymbols` is `true`, symbol properties are also checked.
|
|
871
|
+
*
|
|
872
|
+
* @param {*} value - The value to check.
|
|
873
|
+
* @param {IsEmptyObjectOptions} [options] - Optional settings.
|
|
874
|
+
* @param {boolean} [options.checkSymbols=false] - Whether to also check symbol properties.
|
|
875
|
+
* @returns {boolean} Return `true` if the value is considered empty or not an object, false otherwise.
|
|
876
|
+
* @example
|
|
877
|
+
* isEmptyObject({});
|
|
878
|
+
* // ➔ true
|
|
879
|
+
* isEmptyObject({}, { checkSymbols: true });
|
|
880
|
+
* // ➔ true
|
|
881
|
+
* isEmptyObject({ a: 1 });
|
|
882
|
+
* // ➔ false
|
|
883
|
+
* isEmptyObject({ [Symbol('s')]: 1 });
|
|
884
|
+
* // ➔ true
|
|
885
|
+
* isEmptyObject({ [Symbol('s')]: 1 }, { checkSymbols: true });
|
|
886
|
+
* // ➔ false
|
|
887
|
+
* isEmptyObject(null);
|
|
888
|
+
* // ➔ true (not object)
|
|
889
|
+
* isEmptyObject([]);
|
|
890
|
+
* // ➔ true (not plain object)
|
|
891
|
+
* isEmptyObject(123);
|
|
892
|
+
* // ➔ true (not object)
|
|
893
|
+
*/
|
|
894
|
+
declare function isEmptyObject(value:unknown,options?:IsEmptyObjectOptions):boolean;type IsEmptyStringOptions={
|
|
895
|
+
/** Whether to trim the string before checking.
|
|
896
|
+
*
|
|
897
|
+
* DefaultValue: `true`.
|
|
898
|
+
*
|
|
899
|
+
* @default `true` */
|
|
900
|
+
trim?:boolean;};
|
|
901
|
+
/** ----------------------------------------------------------
|
|
902
|
+
* * ***Predicate: `isEmptyString`.***
|
|
903
|
+
* ----------------------------------------------------------
|
|
904
|
+
* @description Checks whether a given value is an **empty string**.
|
|
905
|
+
*
|
|
906
|
+
* - Considers `""` and whitespace-only strings as empty (if `trim` is enabled, which is the default).
|
|
907
|
+
* - Non-string inputs are also considered empty.
|
|
908
|
+
*
|
|
909
|
+
* @param {*} [value] - The value to check.
|
|
910
|
+
* @param {IsEmptyStringOptions | undefined} [options] - Optional settings.
|
|
911
|
+
* @param {boolean} [options.trim=true] - Whether to trim the string before checking, defaultValue `true`.
|
|
912
|
+
* @returns {boolean} Returns `true` if the value is string not a string or value string is considered empty.
|
|
913
|
+
* @example
|
|
914
|
+
* isEmptyString("");
|
|
915
|
+
* // ➔ true
|
|
916
|
+
* isEmptyString(" ");
|
|
917
|
+
* // ➔ true (default trims)
|
|
918
|
+
* isEmptyString(" ", { trim: false });
|
|
919
|
+
* // ➔ false
|
|
920
|
+
* isEmptyString("hello");
|
|
921
|
+
* // ➔ false
|
|
922
|
+
* isEmptyString(undefined);
|
|
923
|
+
* // ➔ true
|
|
924
|
+
* isEmptyString(null);
|
|
925
|
+
* // ➔ true
|
|
926
|
+
* isEmptyString(123 as any);
|
|
927
|
+
* // ➔ true
|
|
928
|
+
*
|
|
929
|
+
* // Used in validation
|
|
930
|
+
* if (isEmptyString(form.name)) {
|
|
931
|
+
* throw new Error("Name cannot be empty.");
|
|
932
|
+
* }
|
|
933
|
+
*/
|
|
934
|
+
declare const isEmptyString:(value:unknown,options?:IsEmptyStringOptions)=>boolean;type IsEmptyValueOptions={
|
|
935
|
+
/** Whether to check symbol properties when checking empty objects.
|
|
936
|
+
*
|
|
937
|
+
* DefaultValue: `false`.
|
|
938
|
+
*
|
|
939
|
+
* @default false
|
|
940
|
+
*/
|
|
941
|
+
checkSymbols?:boolean;};
|
|
942
|
+
/** ----------------------------------------------------------
|
|
943
|
+
* * ***Predicate: `isEmptyValue`.***
|
|
944
|
+
* ----------------------------------------------------------
|
|
945
|
+
* @description Determines if a value is **`empty`**, covering:
|
|
946
|
+
*
|
|
947
|
+
* - Empty objects: `{}`
|
|
948
|
+
* - Empty arrays: `[]`
|
|
949
|
+
* - Empty strings: `""` or whitespace-only (trimmed)
|
|
950
|
+
* - `null`, `undefined`, `false`, or `NaN`
|
|
951
|
+
*
|
|
952
|
+
* Returns **`false`** for:
|
|
953
|
+
* - Non-empty objects/arrays
|
|
954
|
+
* - Non-empty strings
|
|
955
|
+
* - Numbers (except `NaN`)
|
|
956
|
+
* - Functions, `true`, symbols, etc.
|
|
957
|
+
*
|
|
958
|
+
* @param {*} value - The value to evaluate.
|
|
959
|
+
* @param {IsEmptyValueOptions} options - Optional settings.
|
|
960
|
+
* @returns {boolean} Return `true` if the value is considered empty, otherwise `false`.
|
|
961
|
+
*
|
|
962
|
+
* @example
|
|
963
|
+
* isEmptyValue({});
|
|
964
|
+
* // ➔ true
|
|
965
|
+
* isEmptyValue([]);
|
|
966
|
+
* // ➔ true
|
|
967
|
+
* isEmptyValue({ key: "value" });
|
|
968
|
+
* // ➔ false
|
|
969
|
+
* isEmptyValue({ [Symbol("foo")]: 123 });
|
|
970
|
+
* // ➔ true (default `checkSymbols` is `false`)
|
|
971
|
+
* isEmptyValue({ [Symbol("foo")]: 123 }, { checkSymbols: false });
|
|
972
|
+
* // ➔ true (default `checkSymbols` is `false`)
|
|
973
|
+
* isEmptyValue({ [Symbol("foo")]: 123 }, { checkSymbols: true });
|
|
974
|
+
* // ➔ false
|
|
975
|
+
* isEmptyValue([1, 2, 3]);
|
|
976
|
+
* // ➔ false
|
|
977
|
+
* isEmptyValue(NaN);
|
|
978
|
+
* // ➔ true
|
|
979
|
+
* isEmptyValue(true);
|
|
980
|
+
* // ➔ false
|
|
981
|
+
* isEmptyValue(false);
|
|
982
|
+
* // ➔ true
|
|
983
|
+
* isEmptyValue(null);
|
|
984
|
+
* // ➔ true
|
|
985
|
+
* isEmptyValue(undefined);
|
|
986
|
+
* // ➔ true
|
|
987
|
+
* isEmptyValue("");
|
|
988
|
+
* // ➔ true
|
|
989
|
+
* isEmptyValue(" ");
|
|
990
|
+
* // ➔ true
|
|
991
|
+
* isEmptyValue(0);
|
|
992
|
+
* // ➔ false
|
|
993
|
+
* isEmptyValue(-1);
|
|
994
|
+
* // ➔ false
|
|
995
|
+
* isEmptyValue(2);
|
|
996
|
+
* // ➔ false
|
|
997
|
+
* isEmptyValue(() => {});
|
|
998
|
+
* // ➔ false
|
|
999
|
+
*/
|
|
1000
|
+
declare const isEmptyValue:(value:unknown,options?:IsEmptyValueOptions)=>boolean;
|
|
1001
|
+
/** ----------------------------------------------------
|
|
1002
|
+
* * ***Performs a deep comparison between two values to determine if they are equivalent.***
|
|
1003
|
+
* ----------------------------------------------------------
|
|
1004
|
+
* @description
|
|
1005
|
+
* Checks whether two values are **deeply equal**, not just reference-equal (`===`).
|
|
1006
|
+
*
|
|
1007
|
+
* - This method compares:
|
|
1008
|
+
* - Arrays and TypedArrays
|
|
1009
|
+
* - ArrayBuffers
|
|
1010
|
+
* - Plain objects (`Object`) → own enumerable properties only
|
|
1011
|
+
* - Booleans, Numbers, Strings, Symbols
|
|
1012
|
+
* - Dates
|
|
1013
|
+
* - Errors
|
|
1014
|
+
* - Maps
|
|
1015
|
+
* - Sets
|
|
1016
|
+
* - Regular expressions
|
|
1017
|
+
*
|
|
1018
|
+
* ❌ Functions and DOM nodes are **not supported**.
|
|
1019
|
+
*
|
|
1020
|
+
* @param {*} value The value to compare.
|
|
1021
|
+
* @param {*} other The other value to compare.
|
|
1022
|
+
* @returns {boolean} Returns `true` if the values are equivalent, else `false`.
|
|
1023
|
+
* @example
|
|
1024
|
+
* const obj1 = { user: "fred" };
|
|
1025
|
+
* const obj2 = { user: "fred" };
|
|
1026
|
+
*
|
|
1027
|
+
* isEqual(obj1, obj2);
|
|
1028
|
+
* // ➔ true
|
|
1029
|
+
* obj1 === obj2;
|
|
1030
|
+
* // ➔ false (different references)
|
|
1031
|
+
* isEqual([1, 2, 3], [1, 2, 3]);
|
|
1032
|
+
* // ➔ true
|
|
1033
|
+
* isEqual(new Date("2020-01-01"), new Date("2020-01-01"));
|
|
1034
|
+
* // ➔ true
|
|
1035
|
+
* isEqual(new Set([1, 2]), new Set([2, 1]));
|
|
1036
|
+
* // ➔ true
|
|
1037
|
+
* isEqual(/abc/i, new RegExp("abc", "i"));
|
|
1038
|
+
* // ➔ true
|
|
1039
|
+
* isEqual({ a: 1 }, { a: 1, b: undefined });
|
|
1040
|
+
* // ➔ false
|
|
1041
|
+
*/
|
|
1042
|
+
declare function isEqual(value:unknown,other:unknown):boolean;
|
|
1043
|
+
/** ----------------------------------------------------
|
|
1044
|
+
* * ***Performs a deep comparison between two values with support for a customizer function.***
|
|
1045
|
+
* ----------------------------------------------------
|
|
1046
|
+
* @description
|
|
1047
|
+
* This method is like **{@link isEqual}** except that it accepts a `customizer`
|
|
1048
|
+
* which is invoked to compare values.
|
|
1049
|
+
* - If `customizer` returns `undefined`,
|
|
1050
|
+
* the comparison is handled by the default deep equality algorithm.
|
|
1051
|
+
*
|
|
1052
|
+
* - The `customizer` is invoked with up to six arguments:
|
|
1053
|
+
* - `(value, other, indexOrKey, parent, otherParent, stack)`.
|
|
1054
|
+
*
|
|
1055
|
+
* - Supports comparing arrays, objects, maps, sets, dates, regexes, typed arrays, etc.
|
|
1056
|
+
* - Functions and DOM nodes are **not** supported.
|
|
1057
|
+
*
|
|
1058
|
+
* @param {*} value The value to compare.
|
|
1059
|
+
* @param {*} other The other value to compare.
|
|
1060
|
+
* @param {IsEqualCustomizer} [customizer] The function to customize comparisons.
|
|
1061
|
+
* @returns {boolean} Returns `true` if the values are equivalent, else `false`.
|
|
1062
|
+
* @example
|
|
1063
|
+
* function isGreeting(value: unknown) {
|
|
1064
|
+
* return typeof value === "string" && /^h(?:i|ello)$/.test(value);
|
|
1065
|
+
* }
|
|
1066
|
+
*
|
|
1067
|
+
* function customizer(objValue: unknown, othValue: unknown) {
|
|
1068
|
+
* if (isGreeting(objValue) && isGreeting(othValue)) {
|
|
1069
|
+
* return true;
|
|
1070
|
+
* }
|
|
1071
|
+
* }
|
|
1072
|
+
*
|
|
1073
|
+
* const array = ["hello", "goodbye"];
|
|
1074
|
+
* const other = ["hi", "goodbye"];
|
|
1075
|
+
*
|
|
1076
|
+
* console.log(isEqualWith(array, other, customizer));
|
|
1077
|
+
* // ➔ true
|
|
1078
|
+
*/
|
|
1079
|
+
declare function isEqualWith(value:unknown,other:unknown,customizer?:IsEqualCustomizer):boolean;
|
|
1080
|
+
/** ----------------------------------------------------------
|
|
1081
|
+
* * ***Type guard: `isError`.***
|
|
1082
|
+
* ----------------------------------------------------------
|
|
1083
|
+
* @description Checks whether the given value is an **`Error` object**.
|
|
1084
|
+
*
|
|
1085
|
+
* - ✅ Ensures that the provided value is a valid JavaScript error instance.
|
|
1086
|
+
* - ✅ Useful in TypeScript for narrowing types during error handling.
|
|
1087
|
+
*
|
|
1088
|
+
* @param {*} error - The value to check.
|
|
1089
|
+
* @returns {boolean} Returns `true` if `value` is instance of **[Error](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error)**, else `false`.
|
|
1090
|
+
* @example
|
|
1091
|
+
* isError(new Error("Something went wrong"));
|
|
1092
|
+
* // ➔ true
|
|
1093
|
+
* isError("Error message");
|
|
1094
|
+
* // ➔ false
|
|
1095
|
+
* isError(null);
|
|
1096
|
+
* // ➔ false
|
|
1097
|
+
*/
|
|
1098
|
+
declare const isError:(error:unknown)=>error is Error;
|
|
1099
|
+
/** -----------------------------------------------------------------------------
|
|
1100
|
+
* * ***Checks if a value is a finite primitive number.***
|
|
1101
|
+
* -----------------------------------------------------------------------------
|
|
1102
|
+
* @description
|
|
1103
|
+
* This function verifies that `value` is a **primitive number** and is **finite**
|
|
1104
|
+
* (i.e., not `NaN`, `Infinity`, or `-Infinity`).
|
|
1105
|
+
*
|
|
1106
|
+
* - Behaves like [`Number.isFinite()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number/isFinite).
|
|
1107
|
+
* - But also works as a **TypeScript type guard**.
|
|
1108
|
+
*
|
|
1109
|
+
* @param {*} value - The value to check.
|
|
1110
|
+
* @returns {boolean} Returns `true` if `value` is a finite primitive number, else `false`.
|
|
1111
|
+
*
|
|
1112
|
+
* @example
|
|
1113
|
+
* import * as RzlUtilsJs from "@rzl-zone/utils-js";
|
|
1114
|
+
*
|
|
1115
|
+
* // Strict finite number check (only primitive numbers)
|
|
1116
|
+
* RzlUtilsJs.isFinite(3);
|
|
1117
|
+
* // ➔ true
|
|
1118
|
+
* RzlUtilsJs.isFinite(Number.MIN_VALUE);
|
|
1119
|
+
* // ➔ true
|
|
1120
|
+
* RzlUtilsJs.isFinite("3");
|
|
1121
|
+
* // ➔ false (string is not a number)
|
|
1122
|
+
* RzlUtilsJs.isFinite(NaN);
|
|
1123
|
+
* // ➔ false
|
|
1124
|
+
* RzlUtilsJs.isFinite(Infinity);
|
|
1125
|
+
* // ➔ false
|
|
1126
|
+
* RzlUtilsJs.isFinite(new Number(3));
|
|
1127
|
+
* // ➔ false (Number object is not primitive)
|
|
1128
|
+
*
|
|
1129
|
+
* // Comparison with global isFinite()
|
|
1130
|
+
* isFinite("3");
|
|
1131
|
+
* // ➔ true (global coerces string to number)
|
|
1132
|
+
* isFinite(new Number(3));
|
|
1133
|
+
* // ➔ true (object coerced to primitive number)
|
|
1134
|
+
*/
|
|
1135
|
+
declare function isFinite(value:unknown):value is number;
|
|
1136
|
+
/** ----------------------------------------------------------
|
|
1137
|
+
* * ***Type guard: `isFunction`.***
|
|
1138
|
+
* ----------------------------------------------------------
|
|
1139
|
+
* @description Checks if a value is a function.
|
|
1140
|
+
* - Uses `typeof value === "function"` for strict type checking.
|
|
1141
|
+
* - Supports TypeScript type narrowing with `value is (...args: any[]) => any`.
|
|
1142
|
+
* - Safe alternative to `Function` type (doesn't trigger ESLint warning).
|
|
1143
|
+
*
|
|
1144
|
+
* @param {*} value - The value to check.
|
|
1145
|
+
* @returns {boolean} Return `true` if the value is a function.
|
|
1146
|
+
*
|
|
1147
|
+
* @example
|
|
1148
|
+
* isFunction(() => {});
|
|
1149
|
+
* // ➔ true
|
|
1150
|
+
* isFunction(async () => {});
|
|
1151
|
+
* // ➔ true
|
|
1152
|
+
* isFunction(null);
|
|
1153
|
+
* // ➔ false
|
|
1154
|
+
* isFunction({});
|
|
1155
|
+
* // ➔ false
|
|
1156
|
+
*/
|
|
1157
|
+
declare const isFunction:(value:unknown)=>value is AnyFunction;
|
|
1158
|
+
/** ----------------------------------------------------
|
|
1159
|
+
* * ***Type guard: `isInteger`.***
|
|
1160
|
+
* ----------------------------------------------------------
|
|
1161
|
+
* @description Checks if a value is an integer.
|
|
1162
|
+
*
|
|
1163
|
+
* **Note:** This method is based on
|
|
1164
|
+
* [`Number.isInteger`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number/isInteger).
|
|
1165
|
+
*
|
|
1166
|
+
* @param {*} value The value to check.
|
|
1167
|
+
* @returns {boolean} Returns `true` if `value` is an integer, else `false`.
|
|
1168
|
+
* @example
|
|
1169
|
+
* isInteger(3);
|
|
1170
|
+
* // ➔ true
|
|
1171
|
+
* isInteger(Number.MIN_VALUE);
|
|
1172
|
+
* // ➔ false
|
|
1173
|
+
* isInteger(NaN);
|
|
1174
|
+
* // ➔ false
|
|
1175
|
+
* isInteger(Infinity);
|
|
1176
|
+
* // ➔ false
|
|
1177
|
+
* isInteger(-Infinity);
|
|
1178
|
+
* // ➔ false
|
|
1179
|
+
* isInteger('3');
|
|
1180
|
+
* // ➔ false
|
|
1181
|
+
*/
|
|
1182
|
+
declare function isInteger(value:unknown):value is number;
|
|
1183
|
+
/** ----------------------------------------
|
|
1184
|
+
* * ***Type guard: `isLength`.***
|
|
1185
|
+
* ----------------------------------------------------------
|
|
1186
|
+
* @description Checks whether the given value is a **valid array-like length**.
|
|
1187
|
+
*
|
|
1188
|
+
* - ✅ Ensures the value is a **non-negative integer**.
|
|
1189
|
+
* - ✅ Ensures the value is **not greater than `Number.MAX_SAFE_INTEGER`**.
|
|
1190
|
+
* - ❌ Excludes non-numeric values, `Infinity`, and fractional numbers.
|
|
1191
|
+
*
|
|
1192
|
+
* **Note:** This method is loosely based on
|
|
1193
|
+
* [`ToLength`](http://ecma-international.org/ecma-262/7.0/#sec-tolength).
|
|
1194
|
+
*
|
|
1195
|
+
* A valid length must be a non-negative integer
|
|
1196
|
+
* and **not greater than `Number.MAX_SAFE_INTEGER`**.
|
|
1197
|
+
*
|
|
1198
|
+
* @param {*} value The value to check.
|
|
1199
|
+
* @returns {boolean} Returns `true` if `value` is a valid length, else `false`.
|
|
1200
|
+
* @example
|
|
1201
|
+
* isLength(3);
|
|
1202
|
+
* // ➔ true
|
|
1203
|
+
* isLength(Number.MAX_SAFE_INTEGER);
|
|
1204
|
+
* // ➔ true
|
|
1205
|
+
* isLength(Number.MAX_SAFE_INTEGER + 1);
|
|
1206
|
+
* // ➔ false
|
|
1207
|
+
* isLength("3");
|
|
1208
|
+
* // ➔ false
|
|
1209
|
+
* isLength(-1);
|
|
1210
|
+
* // ➔ false
|
|
1211
|
+
* isLength(3.14);
|
|
1212
|
+
* // ➔ false
|
|
1213
|
+
* isLength(Infinity);
|
|
1214
|
+
* // ➔ false
|
|
1215
|
+
* isLength(-Infinity);
|
|
1216
|
+
* // ➔ false
|
|
1217
|
+
* isLength(Number.MIN_VALUE);
|
|
1218
|
+
* // ➔ false
|
|
1219
|
+
*/
|
|
1220
|
+
declare function isLength(value:unknown):boolean;
|
|
1221
|
+
/** --------------------------------------------------
|
|
1222
|
+
* * ***Type guard: `isMap`.***
|
|
1223
|
+
* ----------------------------------------------------------
|
|
1224
|
+
* @description Checks whether the given value is a **`Map` object**.
|
|
1225
|
+
*
|
|
1226
|
+
* - Ensures that the provided value is an instance of **[Map](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map)**.
|
|
1227
|
+
* - Useful in TypeScript for narrowing types when working with collections.
|
|
1228
|
+
*
|
|
1229
|
+
* @param {*} value The value to check.
|
|
1230
|
+
* @returns {boolean} Returns `true` if `value` is instance of **[Map](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map)**, else `false`.
|
|
1231
|
+
* @example
|
|
1232
|
+
* isMap(new Map());
|
|
1233
|
+
* // ➔ true
|
|
1234
|
+
* isMap(new WeakMap());
|
|
1235
|
+
* // ➔ false
|
|
1236
|
+
* isMap({});
|
|
1237
|
+
* // ➔ false
|
|
1238
|
+
*/
|
|
1239
|
+
declare function isMap<K=unknown,V=unknown>(value:Map<K,V>):value is Map<K,V>;declare function isMap(value:unknown):value is Map<unknown,unknown>;
|
|
1240
|
+
/** ----------------------------------------------------
|
|
1241
|
+
* * ***Performs a partial deep comparison between `object` and `source`.***
|
|
1242
|
+
* ----------------------------------------------------
|
|
1243
|
+
* @description Determines whether `object` contains equivalent property values from `source`.
|
|
1244
|
+
*
|
|
1245
|
+
* - ✅ Returns `true` if **all properties** in `source` exist in `object` and are deeply equal.
|
|
1246
|
+
* - ❌ Does **not** require `object` and `source` to be the same shape—`object` may have extra properties.
|
|
1247
|
+
* - ⚠️ Arrays are treated as objects: only matching indexed keys are compared.
|
|
1248
|
+
*
|
|
1249
|
+
* @remarks
|
|
1250
|
+
* - This is functionally equivalent to a partially applied `matches(source)` predicate.
|
|
1251
|
+
* - Special cases:
|
|
1252
|
+
* - An empty array (`[]`) in `source` matches any array in `object`.
|
|
1253
|
+
* - An empty object (`{}`) in `source` matches any object in `object`.
|
|
1254
|
+
* @param {object} object - The object to inspect.
|
|
1255
|
+
* @param {object} source - The object containing property values to match.
|
|
1256
|
+
* @returns {boolean} Returns `true` if `object` is a match, else `false`.
|
|
1257
|
+
* @example
|
|
1258
|
+
* const object = { a: 1, b: 2 };
|
|
1259
|
+
*
|
|
1260
|
+
* isMatch(object, { b: 2 });
|
|
1261
|
+
* // ➔ true
|
|
1262
|
+
* isMatch(object, { b: 1 });
|
|
1263
|
+
* // ➔ false
|
|
1264
|
+
* isMatch([1, 2, 3], [1, 2]);
|
|
1265
|
+
* // ➔ true (treats arrays as objects with index keys)
|
|
1266
|
+
*/
|
|
1267
|
+
declare function isMatch(object:object,source:object):boolean;
|
|
1268
|
+
/** ----------------------------------------------------
|
|
1269
|
+
* * ***Performs a partial deep comparison between `object` and `source`,
|
|
1270
|
+
* like `isMatch`, but with a `customizer` function to control comparisons.***
|
|
1271
|
+
* ----------------------------------------------------
|
|
1272
|
+
* If `customizer` returns a value other than `undefined`, that value is used
|
|
1273
|
+
* as the result of the comparison for the current property. Otherwise,
|
|
1274
|
+
* the comparison falls back to the default deep equality logic.
|
|
1275
|
+
*
|
|
1276
|
+
* @remarks
|
|
1277
|
+
* - The `customizer` function is invoked with up to **five** arguments:
|
|
1278
|
+
* `(objValue, srcValue, keyOrIndex, object, source)`.
|
|
1279
|
+
* - Returning `true` from `customizer` will short-circuit further comparison
|
|
1280
|
+
* for that key.
|
|
1281
|
+
* - Returning `false` will cause `isMatchWith` to return `false` immediately.
|
|
1282
|
+
* - Returning `undefined` allows default comparison to proceed.
|
|
1283
|
+
* @param {*} value - The object to inspect.
|
|
1284
|
+
* @param {*} other - The object of property values to match.
|
|
1285
|
+
* @param {isMatchWithCustomizer} customizer - The function to customize comparisons.
|
|
1286
|
+
* @returns Returns `true` if `object` is a match, else `false`.
|
|
1287
|
+
*
|
|
1288
|
+
* @example
|
|
1289
|
+
* function isGreeting(value: unknown) {
|
|
1290
|
+
* return typeof value === 'string' && /^h(?:i|ello)$/.test(value);
|
|
1291
|
+
* }
|
|
1292
|
+
*
|
|
1293
|
+
* function customizer(objValue: unknown, srcValue: unknown) {
|
|
1294
|
+
* if (isGreeting(objValue) && isGreeting(srcValue)) {
|
|
1295
|
+
* return true;
|
|
1296
|
+
* }
|
|
1297
|
+
* }
|
|
1298
|
+
*
|
|
1299
|
+
* const object = { greeting: 'hello' };
|
|
1300
|
+
* const source = { greeting: 'hi' };
|
|
1301
|
+
*
|
|
1302
|
+
* isMatchWith(object, source, customizer);
|
|
1303
|
+
* // ➔ true
|
|
1304
|
+
*/
|
|
1305
|
+
declare function isMatchWith(value:object,other:object,customizer?:isMatchWithCustomizer):boolean;
|
|
1306
|
+
/** ----------------------------------------------------
|
|
1307
|
+
* * ***Type guard: `isNaN`.***
|
|
1308
|
+
* ----------------------------------------------------
|
|
1309
|
+
* @description Checks if a value is [`NaN`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/NaN).
|
|
1310
|
+
*
|
|
1311
|
+
* **Note:** This method is based on [`Number.isNaN`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number/isNaN)
|
|
1312
|
+
* and is **not** the same as the global [`isNaN`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/isNaN),
|
|
1313
|
+
* which returns `true` for `undefined` and other non-number values.
|
|
1314
|
+
*
|
|
1315
|
+
* @param {*} value The value to check.
|
|
1316
|
+
* @returns {boolean} Returns `true` if `value` is `NaN`, else `false`.
|
|
1317
|
+
* @example
|
|
1318
|
+
* import * as RzlUtilsJs from "@rzl-zone/utils-js";
|
|
1319
|
+
*
|
|
1320
|
+
* RzlUtilsJs.isNaN(NaN);
|
|
1321
|
+
* // ➔ true
|
|
1322
|
+
* RzlUtilsJs.isNaN(new Number(NaN));
|
|
1323
|
+
* // ➔ true
|
|
1324
|
+
* RzlUtilsJs.isNaN(undefined);
|
|
1325
|
+
* // ➔ false
|
|
1326
|
+
*
|
|
1327
|
+
* // This global isNaN:
|
|
1328
|
+
* isNaN(undefined);
|
|
1329
|
+
* // ➔ true
|
|
1330
|
+
*/
|
|
1331
|
+
declare function isNaN(value:unknown):boolean;
|
|
1332
|
+
/** ----------------------------------------------------
|
|
1333
|
+
* * ***Type guard: `isNative`.***
|
|
1334
|
+
* ----------------------------------------------------------
|
|
1335
|
+
* @description Checks if a value is a **pristine native function**.
|
|
1336
|
+
*
|
|
1337
|
+
* **Note:**
|
|
1338
|
+
* - This method may not reliably detect native functions when using packages
|
|
1339
|
+
* like `core-js`, as they override native behavior.
|
|
1340
|
+
* - Attempts to detect native functions
|
|
1341
|
+
* in such environments may fail or throw errors.
|
|
1342
|
+
* - This also affects packages like
|
|
1343
|
+
* [babel-polyfill](https://www.npmjs.com/package/babel-polyfill).
|
|
1344
|
+
*
|
|
1345
|
+
* @param {*} value The value to check.
|
|
1346
|
+
* @returns {boolean} Returns `true` if `value` is a native function,
|
|
1347
|
+
* else `false`.
|
|
1348
|
+
* @example
|
|
1349
|
+
* isNative(Array.prototype.push);
|
|
1350
|
+
* // ➔ true
|
|
1351
|
+
*
|
|
1352
|
+
* import * as RzlUtilsJs from "@rzl-zone/utils-js";
|
|
1353
|
+
* isNative(RzlUtilsJs);
|
|
1354
|
+
* // ➔ false
|
|
1355
|
+
*/
|
|
1356
|
+
declare function isNative(value?:unknown):value is AnyFunction;
|
|
1357
|
+
/** ----------------------------------------------------
|
|
1358
|
+
* * ***Type guard: `isNil`.***
|
|
1359
|
+
* ----------------------------------------------------------
|
|
1360
|
+
* @description Checks if a value is `null` or `undefined`.
|
|
1361
|
+
*
|
|
1362
|
+
* @param {*} value - The value to check.
|
|
1363
|
+
* @returns {boolean} Returns `true` if the value is `null` or `undefined`, otherwise `false`.
|
|
1364
|
+
* @example
|
|
1365
|
+
* isNil(null);
|
|
1366
|
+
* // ➔ true
|
|
1367
|
+
* isNil(undefined);
|
|
1368
|
+
* // ➔ true
|
|
1369
|
+
* isNil(void 0);
|
|
1370
|
+
* // ➔ true
|
|
1371
|
+
* isNil(NaN);
|
|
1372
|
+
* // ➔ false
|
|
1373
|
+
*/
|
|
1374
|
+
declare function isNil(value?:unknown):value is null|undefined;
|
|
1375
|
+
/** ----------------------------------------------------------
|
|
1376
|
+
* * ***Type guard: `isNonEmptyArray`.***
|
|
1377
|
+
* ----------------------------------------------------------
|
|
1378
|
+
* @description Checks if a value is a **non-empty array**.
|
|
1379
|
+
*
|
|
1380
|
+
* - Ensures the value is an actual array using **[`Array.isArray`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/isArray)**.
|
|
1381
|
+
* - Ensures the array contains at least one item.
|
|
1382
|
+
* - Narrows type to `T[]` (non-empty array) when true.
|
|
1383
|
+
*
|
|
1384
|
+
* @template T - The type of the value being checked.
|
|
1385
|
+
* @param {*} value - The value to check.
|
|
1386
|
+
* @returns {boolean} Return `true` if value is a non-empty array.
|
|
1387
|
+
*
|
|
1388
|
+
* @example
|
|
1389
|
+
* isNonEmptyArray([1, 2, 3]); // ➔ true
|
|
1390
|
+
* isNonEmptyArray([]); // ➔ false
|
|
1391
|
+
* isNonEmptyArray(null); // ➔ false
|
|
1392
|
+
* isNonEmptyArray("test"); // ➔ false
|
|
1393
|
+
*/
|
|
1394
|
+
declare function isNonEmptyArray(value:[]):value is [];declare function isNonEmptyArray<T extends unknown[]>(value:T):value is NonNullable<Extract<T,unknown[]>>;declare function isNonEmptyArray(value:unknown):value is unknown[];type IsNonEmptyStringOptions={
|
|
1395
|
+
/**
|
|
1396
|
+
* Whether to trim the string before checking.
|
|
1397
|
+
*
|
|
1398
|
+
* @default `true` */
|
|
1399
|
+
trim?:boolean;};
|
|
1400
|
+
/** ----------------------------------------------------------
|
|
1401
|
+
* * ***Type guard: `isNonEmptyString`.***
|
|
1402
|
+
* ----------------------------------------------------------
|
|
1403
|
+
* @description Checks if a value is a **non-empty string**.
|
|
1404
|
+
*
|
|
1405
|
+
* Determines whether the given `value` is a string containing at least one non-whitespace character, with optional trimming behavior.
|
|
1406
|
+
*
|
|
1407
|
+
* - Ensures the value is a string using **{@link isString}**.
|
|
1408
|
+
* - Optionally trims whitespace before checking (`trim` defaults to `true`).
|
|
1409
|
+
* - Narrows type to `string` when true.
|
|
1410
|
+
*
|
|
1411
|
+
* @param {*} value - The value to test.
|
|
1412
|
+
* @param {IsNonEmptyStringOptions} options - Optional settings.
|
|
1413
|
+
* @param {boolean} options.trim - If `true`, trims the string before checking. Defaults to `true`.
|
|
1414
|
+
*
|
|
1415
|
+
* @returns {boolean} `true` if `value` is a non-empty string, otherwise `false`.
|
|
1416
|
+
*
|
|
1417
|
+
* @example
|
|
1418
|
+
* isNonEmptyString("hello");
|
|
1419
|
+
* // ➔ true
|
|
1420
|
+
* isNonEmptyString(" ", { trim: true });
|
|
1421
|
+
* // ➔ false
|
|
1422
|
+
* isNonEmptyString(" ", { trim: false });
|
|
1423
|
+
* // ➔ true
|
|
1424
|
+
* isNonEmptyString("");
|
|
1425
|
+
* // ➔ false
|
|
1426
|
+
* isNonEmptyString(123);
|
|
1427
|
+
* // ➔ false
|
|
1428
|
+
* isNonEmptyString(undefined);
|
|
1429
|
+
* // ➔ false
|
|
1430
|
+
* isNonEmptyString(null);
|
|
1431
|
+
* // ➔ false
|
|
1432
|
+
* isNonEmptyString({});
|
|
1433
|
+
* // ➔ false
|
|
1434
|
+
* isNonEmptyString([]);
|
|
1435
|
+
* // ➔ false
|
|
1436
|
+
*/
|
|
1437
|
+
declare const isNonEmptyString:(value:unknown,options?:IsNonEmptyStringOptions)=>value is string;type IsNonEmptyValueOptions={
|
|
1438
|
+
/**
|
|
1439
|
+
* Whether to check symbol properties when checking empty objects.
|
|
1440
|
+
* @default false
|
|
1441
|
+
*/
|
|
1442
|
+
checkSymbols?:boolean;};
|
|
1443
|
+
/** ----------------------------------------------------------
|
|
1444
|
+
* * ***Determines if a value is a **non-empty** object (`{}` with props), **non-empty** array (`[]` with items)
|
|
1445
|
+
* or generally truthy.***
|
|
1446
|
+
* ----------------------------------------------------------
|
|
1447
|
+
*
|
|
1448
|
+
* - Returns `true` for objects with properties, non-empty arrays, numbers (except NaN), functions, `true`, and other truthy values.
|
|
1449
|
+
* - Returns `false` for `{}`, `[]`, `null`, `undefined`, `""`, `" "`, `false`, and `NaN`.
|
|
1450
|
+
* - Safely handles `null`, `undefined`, and non-object types without throwing.
|
|
1451
|
+
*
|
|
1452
|
+
* - Returns `true` for `{}`, `[]`, `null`, `undefined`, `""`, `" "`, `false`, and `NaN`.
|
|
1453
|
+
* - Returns `false` for objects with properties, non-empty arrays, numbers, functions, `true` (Truthy) and other non-empty values.
|
|
1454
|
+
* - Safely handles `null`, `undefined`, and non-object types without throwing.
|
|
1455
|
+
*
|
|
1456
|
+
* @param {*} value - The value to evaluate.
|
|
1457
|
+
* @param {IsNonEmptyValueOptions} options - Optional settings.
|
|
1458
|
+
* @returns `true` if the value is considered non-empty/truthy, otherwise `false`.
|
|
1459
|
+
*
|
|
1460
|
+
* @example
|
|
1461
|
+
* isNonEmptyValue({});
|
|
1462
|
+
* // ➔ false
|
|
1463
|
+
* isNonEmptyValue([]);
|
|
1464
|
+
* // ➔ false
|
|
1465
|
+
* isNonEmptyValue({ key: "value" });
|
|
1466
|
+
* // ➔ true
|
|
1467
|
+
* isNonEmptyValue({ [Symbol("foo")]: 123 });
|
|
1468
|
+
* // ➔ false (default `checkSymbols` is `false`)
|
|
1469
|
+
* isNonEmptyValue({ [Symbol("foo")]: 123 }, { checkSymbols: false });
|
|
1470
|
+
* // ➔ false (default `checkSymbols` is `false`)
|
|
1471
|
+
* isNonEmptyValue({ [Symbol("foo")]: 123 }, { checkSymbols: true });
|
|
1472
|
+
* // ➔ true
|
|
1473
|
+
* isNonEmptyValue([1, 2, 3]);
|
|
1474
|
+
* // ➔ true
|
|
1475
|
+
* isNonEmptyValue(NaN);
|
|
1476
|
+
* // ➔ false
|
|
1477
|
+
* isNonEmptyValue(true);
|
|
1478
|
+
* // ➔ true
|
|
1479
|
+
* isNonEmptyValue(false);
|
|
1480
|
+
* // ➔ false
|
|
1481
|
+
* isNonEmptyValue(null);
|
|
1482
|
+
* // ➔ false
|
|
1483
|
+
* isNonEmptyValue(undefined);
|
|
1484
|
+
* // ➔ false
|
|
1485
|
+
* isNonEmptyValue("");
|
|
1486
|
+
* // ➔ false
|
|
1487
|
+
* isNonEmptyValue(" ");
|
|
1488
|
+
* // ➔ false
|
|
1489
|
+
* isNonEmptyValue(0);
|
|
1490
|
+
* // ➔ true
|
|
1491
|
+
* isNonEmptyValue(-1);
|
|
1492
|
+
* // ➔ true
|
|
1493
|
+
* isNonEmptyValue(2);
|
|
1494
|
+
* // ➔ true
|
|
1495
|
+
* isNonEmptyValue(() => {});
|
|
1496
|
+
* // ➔ true
|
|
1497
|
+
*/
|
|
1498
|
+
declare const isNonEmptyValue:(value:unknown,options?:IsNonEmptyValueOptions)=>boolean;
|
|
1499
|
+
/** ---------------------------------------------------------
|
|
1500
|
+
* * ***Type guard: `isNull`.***
|
|
1501
|
+
* ----------------------------------------------------------
|
|
1502
|
+
* @description Checks if a value is **[`null`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/null)**.
|
|
1503
|
+
*
|
|
1504
|
+
* - Strictly compares the value against `null`.
|
|
1505
|
+
* - Narrows type to `null` when true.
|
|
1506
|
+
*
|
|
1507
|
+
* @param {*} val - The value to check.
|
|
1508
|
+
* @returns {val is null} Returns `true` if the value is `null`, otherwise `false`.
|
|
1509
|
+
*
|
|
1510
|
+
* @example
|
|
1511
|
+
* isNull(null); // ➔ true
|
|
1512
|
+
* isNull(0); // ➔ false
|
|
1513
|
+
* isNull(undefined); // ➔ false
|
|
1514
|
+
*/
|
|
1515
|
+
declare const isNull:(val:unknown)=>val is null;type HasKeys$1<T>=keyof T extends never?false:true;type IsObject<T>=unknown extends T?T & Record<PropertyKey,unknown>:T extends object?T extends AnObjectNonArray?T:HasKeys$1<T>extends false?T & Record<PropertyKey,unknown>:IsArray<T>extends true?Exclude<T,unknown[]>:T:never;
|
|
1516
|
+
/** ---------------------------------------------------------
|
|
1517
|
+
* * ***Type guard: `isObject`.***
|
|
1518
|
+
* ----------------------------------------------------------
|
|
1519
|
+
* @description
|
|
1520
|
+
* Checks if a value is an **object** (excluding `null` and arrays).
|
|
1521
|
+
*
|
|
1522
|
+
* - ✅ Returns `true` for any non-null object (arrays excluded), including:
|
|
1523
|
+
* - Plain objects (`{}`, `Object.create(null)`)
|
|
1524
|
+
* - Custom class instances
|
|
1525
|
+
* - Built-ins: `Date`, `RegExp`, `Error`, `URL`, `URLSearchParams`
|
|
1526
|
+
* - Collections: `Map`, `Set`, `WeakMap`, `WeakSet`
|
|
1527
|
+
* - Binary/typed data: `ArrayBuffer`, `DataView`, typed arrays (`Uint8Array`, `Int32Array`, etc.)
|
|
1528
|
+
* - DOM/Node objects: `HTMLElement`, `DocumentFragment`, etc.
|
|
1529
|
+
* - Proxies (wrapping any object type)
|
|
1530
|
+
* ---------------------------------------------------------
|
|
1531
|
+
* - ❌ Returns `false` for:
|
|
1532
|
+
* - `null`
|
|
1533
|
+
* - Arrays (`[]`, `new Array()`)
|
|
1534
|
+
* - Functions (regular functions, arrow functions, class constructors)
|
|
1535
|
+
* - Primitives: `string`, `number`, `boolean`, `symbol`, `bigint`
|
|
1536
|
+
* - Boxed primitives: `new String()`, `new Number()`, `new Boolean()`
|
|
1537
|
+
* - `undefined` (including `NaN`, which is a primitive number)
|
|
1538
|
+
*
|
|
1539
|
+
* Note: If you specifically need to check for ***plain objects***, use **{@link isPlainObject}** instead.
|
|
1540
|
+
*
|
|
1541
|
+
* @template T - The type of the value being checked.
|
|
1542
|
+
* @param {*} value - The value to check.
|
|
1543
|
+
* @returns {boolean} Returns `true` if the value is a plain object, otherwise `false`.
|
|
1544
|
+
*
|
|
1545
|
+
* @example
|
|
1546
|
+
* isObject({}); // ➔ true
|
|
1547
|
+
* isObject(Object.create(null)); // ➔ true
|
|
1548
|
+
* isObject(new Date()); // ➔ true
|
|
1549
|
+
* isObject(new Map()); // ➔ true
|
|
1550
|
+
* isObject(new Uint8Array()); // ➔ true
|
|
1551
|
+
* isObject(new String("x")); // ➔ true
|
|
1552
|
+
* isObject([]); // ➔ false
|
|
1553
|
+
* isObject(null); // ➔ false
|
|
1554
|
+
* isObject(undefined); // ➔ false
|
|
1555
|
+
* isObject(123); // ➔ false
|
|
1556
|
+
* isObject(() => {}); // ➔ false
|
|
1557
|
+
*/
|
|
1558
|
+
declare function isObject<T extends object>(value:T):value is IsObject<T>;declare function isObject(value:unknown):value is Record<PropertyKey,unknown>;
|
|
1559
|
+
/** ----------------------------------------------------------
|
|
1560
|
+
* * ***Type guard: `isObjectLoose`.***
|
|
1561
|
+
* ----------------------------------------------------------
|
|
1562
|
+
* @description
|
|
1563
|
+
* Checks if a value is the
|
|
1564
|
+
* [ECMAScript language type **Object**](http://www.ecma-international.org/ecma-262/7.0/#sec-ecmascript-language-types).
|
|
1565
|
+
*
|
|
1566
|
+
* - ✅ Returns `true` for:
|
|
1567
|
+
* - Plain objects (`{}`)
|
|
1568
|
+
* - Arrays (`[]`)
|
|
1569
|
+
* - Functions
|
|
1570
|
+
* - Regexes (`/abc/`)
|
|
1571
|
+
* - Boxed primitives:
|
|
1572
|
+
* - `new Number(0)`
|
|
1573
|
+
* - `new String("")`
|
|
1574
|
+
* - `new Boolean(false)`
|
|
1575
|
+
* ----------------------------
|
|
1576
|
+
* - ❌ Returns `false` for:
|
|
1577
|
+
* - `null`
|
|
1578
|
+
* - `undefined`
|
|
1579
|
+
* - Primitives:
|
|
1580
|
+
* - `string`
|
|
1581
|
+
* - `number`
|
|
1582
|
+
* - `boolean`
|
|
1583
|
+
* - `symbol`
|
|
1584
|
+
* - `bigint`
|
|
1585
|
+
*
|
|
1586
|
+
* @note ⚠️ **For More Strict Object Use {@link isObject} or {@link isPlainObject} instead.**
|
|
1587
|
+
*
|
|
1588
|
+
* @template T - The type of the value being checked.
|
|
1589
|
+
* @param {*} value The value to check.
|
|
1590
|
+
* @returns {boolean} Returns `true` if `value` is an object, else `false`.
|
|
1591
|
+
* @example
|
|
1592
|
+
* isObjectLoose({});
|
|
1593
|
+
* // ➔ true
|
|
1594
|
+
* isObjectLoose([1, 2, 3]);
|
|
1595
|
+
* // ➔ true
|
|
1596
|
+
* isObjectLoose(()=> {});
|
|
1597
|
+
* // ➔ true
|
|
1598
|
+
* isObjectLoose(null);
|
|
1599
|
+
* // ➔ false
|
|
1600
|
+
* isObjectLoose(undefined);
|
|
1601
|
+
* // ➔ false
|
|
1602
|
+
*/
|
|
1603
|
+
declare function isObjectLoose<T=object>(value:unknown):value is T;type HasKeys<T>=keyof T extends never?false:true;type IsObjectOrArray<T>=OrArr<[ IsNever<T>,Extends<T,Record<PropertyKey,unknown>>,Extends<unknown,T>]>extends true?T & Record<PropertyKey,unknown>& unknown[]:T extends object?T extends unknown[]?T:T extends AnObjectNonArray?T:HasKeys<T>extends false?T & Record<PropertyKey,unknown>:T:Extract<T,Record<PropertyKey,unknown>& unknown[]>;
|
|
1604
|
+
/** ---------------------------------------------------------
|
|
1605
|
+
* * ***Type guard: `isObjectOrArray`.***
|
|
1606
|
+
* ----------------------------------------------------------
|
|
1607
|
+
* @description
|
|
1608
|
+
* Checks if a value is an **object** or an **array**.
|
|
1609
|
+
*
|
|
1610
|
+
* - ✅ Returns `true` for:
|
|
1611
|
+
* - Plain objects (`{}`, `Object.create(null)`)
|
|
1612
|
+
* - Custom objects
|
|
1613
|
+
* - Arrays (`[]`, `[1,2,3]`)
|
|
1614
|
+
* ----------------------------
|
|
1615
|
+
* - ❌ Returns `false` for:
|
|
1616
|
+
* - `null`
|
|
1617
|
+
* - `undefined`
|
|
1618
|
+
* - Primitives:
|
|
1619
|
+
* - `string`
|
|
1620
|
+
* - `number`
|
|
1621
|
+
* - `boolean`
|
|
1622
|
+
* - `symbol`
|
|
1623
|
+
* - `bigint`
|
|
1624
|
+
* - Functions
|
|
1625
|
+
*
|
|
1626
|
+
* @template T - The type of the value being checked.
|
|
1627
|
+
* @param {*} value - The value to check.
|
|
1628
|
+
* @returns {boolean} Returns `true` if the value is an `object` or `array`.
|
|
1629
|
+
*
|
|
1630
|
+
* @example
|
|
1631
|
+
* isObjectOrArray({ name: "Alice" }); // ➔ true
|
|
1632
|
+
* isObjectOrArray([1,2,3]); // ➔ true
|
|
1633
|
+
* isObjectOrArray(null); // ➔ false
|
|
1634
|
+
* isObjectOrArray(undefined); // ➔ false
|
|
1635
|
+
* isObjectOrArray("hello"); // ➔ false
|
|
1636
|
+
*/
|
|
1637
|
+
declare function isObjectOrArray(value:[]):value is [];declare function isObjectOrArray<T>(value:T):value is IsObjectOrArray<T>;
|
|
1638
|
+
/** ----------------------------------------------------------
|
|
1639
|
+
* * ***Type guard: `isRegExp`.***
|
|
1640
|
+
* ----------------------------------------------------------
|
|
1641
|
+
* @description Checks if a value is a RegExp instance.
|
|
1642
|
+
*
|
|
1643
|
+
* @param {*} value - The value to check.
|
|
1644
|
+
* @returns {boolean} Return `true` if value is an instance of **[RegExp](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/RegExp)**.
|
|
1645
|
+
*
|
|
1646
|
+
* @example
|
|
1647
|
+
* isRegExp(/abc/); // ➔ true
|
|
1648
|
+
* isRegExp(new RegExp("abc")); // ➔ true
|
|
1649
|
+
* isRegExp("abc"); // ➔ false
|
|
1650
|
+
*/
|
|
1651
|
+
declare const isRegExp:(value:unknown)=>value is RegExp;
|
|
1652
|
+
/** --------------------------------------------------
|
|
1653
|
+
* * ***Checks if `value` is a **[`Safe-Integer`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number/isSafeInteger)**.***
|
|
1654
|
+
* --------------------------------------------------
|
|
1655
|
+
* An integer is considered *safe* if:
|
|
1656
|
+
* - It is an IEEE-754 **double precision number**.
|
|
1657
|
+
* - It can be exactly represented without rounding errors.
|
|
1658
|
+
* - It lies within the range **-(2^53 - 1) to 2^53 - 1**.
|
|
1659
|
+
*
|
|
1660
|
+
* **Note:** This method is based on **{@link Number.isSafeInteger}**.
|
|
1661
|
+
*
|
|
1662
|
+
* @param {*} value - The value to check.
|
|
1663
|
+
* @returns {boolean} Return `true` if `value` is a safe integer, otherwise `false`.
|
|
1664
|
+
* @example
|
|
1665
|
+
* isSafeInteger(3);
|
|
1666
|
+
* // ➔ true
|
|
1667
|
+
* isSafeInteger(Number.MIN_VALUE);
|
|
1668
|
+
* // ➔ false
|
|
1669
|
+
* isSafeInteger(Infinity);
|
|
1670
|
+
* // ➔ false
|
|
1671
|
+
* isSafeInteger('3');
|
|
1672
|
+
* // ➔ false
|
|
1673
|
+
*/
|
|
1674
|
+
declare function isSafeInteger(value:unknown):value is number;
|
|
1675
|
+
/** ---------------------------------------------------------
|
|
1676
|
+
* * ***Type guard: `isSet`.***
|
|
1677
|
+
* ----------------------------------------------------------
|
|
1678
|
+
* @description Checks if a value is a **[`Set`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Set/Set)** object.
|
|
1679
|
+
*
|
|
1680
|
+
* - Narrows type to `Set<T>` when true.
|
|
1681
|
+
* - Excludes `WeakSet`, arrays, plain objects, and other non-Set values.
|
|
1682
|
+
*
|
|
1683
|
+
* @template T - The type of the value being checked.
|
|
1684
|
+
* @param {*} value - The value to check.
|
|
1685
|
+
* @returns {boolean} Returns `true` if the value is a `Set`, otherwise `false`.
|
|
1686
|
+
* @example
|
|
1687
|
+
* isSet(new Set);
|
|
1688
|
+
* // ➔ true
|
|
1689
|
+
* isSet(new WeakSet);
|
|
1690
|
+
* // ➔ false
|
|
1691
|
+
*/
|
|
1692
|
+
declare function isSet<T=unknown>(value:Set<T>):value is Set<T>;declare function isSet(value:unknown):value is Set<unknown>;
|
|
1693
|
+
/** ---------------------------------------------------------
|
|
1694
|
+
* * ***Type guard: `isString`.***
|
|
1695
|
+
* ----------------------------------------------------------
|
|
1696
|
+
* @description Checks if a value is of type
|
|
1697
|
+
* **[`string`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)**.
|
|
1698
|
+
*
|
|
1699
|
+
* - Uses the `typeof` operator for strict checking.
|
|
1700
|
+
* - Narrows type to `string` when true.
|
|
1701
|
+
*
|
|
1702
|
+
* @param {*} value - The value to check.
|
|
1703
|
+
* @returns {boolean} Returns `true` if the value is a string, otherwise `false`.
|
|
1704
|
+
*
|
|
1705
|
+
* @example
|
|
1706
|
+
* isString("hello"); // ➔ true
|
|
1707
|
+
* isString(123); // ➔ false
|
|
1708
|
+
*
|
|
1709
|
+
* // Usage in type narrowing
|
|
1710
|
+
* const value: unknown = getValue();
|
|
1711
|
+
* if (isString(value)) {
|
|
1712
|
+
* // TypeScript now knows `value` is a string
|
|
1713
|
+
* console.log(value.toUpperCase());
|
|
1714
|
+
* }
|
|
1715
|
+
*/
|
|
1716
|
+
declare const isString:(value:unknown)=>value is string;
|
|
1717
|
+
/** ----------------------------------------------------------
|
|
1718
|
+
* * ***Type guard: `isSymbol`.***
|
|
1719
|
+
* ----------------------------------------------------------
|
|
1720
|
+
* @description Checks if a value is of type
|
|
1721
|
+
* **[`symbol`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/Symbol)**.
|
|
1722
|
+
*
|
|
1723
|
+
* - Uses the `typeof` operator for strict checking.
|
|
1724
|
+
* - Narrows type to `symbol` when true.
|
|
1725
|
+
*
|
|
1726
|
+
* @param {*} value - The value to check.
|
|
1727
|
+
* @returns {boolean} Returns `true` if the value is a symbol, otherwise `false`.
|
|
1728
|
+
*
|
|
1729
|
+
* @example
|
|
1730
|
+
* isSymbol(Symbol("id")); // ➔ true
|
|
1731
|
+
* isSymbol("not a symbol"); // ➔ false
|
|
1732
|
+
* isSymbol(123); // ➔ false
|
|
1733
|
+
* isSymbol(undefined); // ➔ false
|
|
1734
|
+
*/
|
|
1735
|
+
declare const isSymbol:(value:unknown)=>value is symbol;
|
|
1736
|
+
/** --------------------------------------------------
|
|
1737
|
+
* * ***Type guard: `isTypedArray`.***
|
|
1738
|
+
* ----------------------------------------------------------
|
|
1739
|
+
* @description Checks if `value` is classified as a
|
|
1740
|
+
* **[TypedArray](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray)**.
|
|
1741
|
+
*
|
|
1742
|
+
* - Validates that `value` is a non-null object.
|
|
1743
|
+
* - Uses `Object.prototype.toString` tag matching against known typed array tags.
|
|
1744
|
+
* - Narrows type to **{@link TypedArray}** when true.
|
|
1745
|
+
*
|
|
1746
|
+
* @param {*} value - The value to check.
|
|
1747
|
+
* @returns {boolean} Returns `true` if the value is a typed array, otherwise `false`.
|
|
1748
|
+
* @example
|
|
1749
|
+
* isTypedArray(new Uint8Array); // ➔ true
|
|
1750
|
+
* isTypedArray(new Uint8Array()); // ➔ true
|
|
1751
|
+
* isTypedArray(new Float32Array()); // ➔ true
|
|
1752
|
+
* isTypedArray(new Uint8ClampedArray()); // ➔ true
|
|
1753
|
+
* isTypedArray([]); // ➔ false
|
|
1754
|
+
* isTypedArray(Buffer.from("hi")); // ➔ false
|
|
1755
|
+
*/
|
|
1756
|
+
declare function isTypedArray(value:unknown):value is TypedArray;
|
|
1757
|
+
/** ---------------------------------------------------------
|
|
1758
|
+
* * ***Type guard: `isURL`.***
|
|
1759
|
+
* ----------------------------------------------------------
|
|
1760
|
+
* @description Checks if a value is an instance of the
|
|
1761
|
+
* **[`URL`](https://developer.mozilla.org/docs/Web/API/URL)** class.
|
|
1762
|
+
*
|
|
1763
|
+
* - Narrows type to `URL` when true.
|
|
1764
|
+
* - Excludes strings, plain objects, and other non-URL values.
|
|
1765
|
+
*
|
|
1766
|
+
* @param {*} value - The value to check.
|
|
1767
|
+
* @returns {boolean} Returns `true` if the value is an instance of `URL`, otherwise `false`.
|
|
1768
|
+
*
|
|
1769
|
+
* @example
|
|
1770
|
+
* isURL(new URL("https://example.com"));
|
|
1771
|
+
* // ➔ true
|
|
1772
|
+
* isURL("https://example.com");
|
|
1773
|
+
* // ➔ false
|
|
1774
|
+
*/
|
|
1775
|
+
declare const isURL:(value:unknown)=>value is URL;
|
|
1776
|
+
/** ---------------------------------------------------------
|
|
1777
|
+
* * ***Type guard: `isUndefined`.***
|
|
1778
|
+
* ----------------------------------------------------------
|
|
1779
|
+
* @description Checks if a value is
|
|
1780
|
+
* **[`undefined`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/undefined)**.
|
|
1781
|
+
*
|
|
1782
|
+
* - Narrows type to `undefined` when true.
|
|
1783
|
+
* - Excludes `null`, objects, arrays, strings, numbers, and all other values.
|
|
1784
|
+
*
|
|
1785
|
+
* @param {*} value - The value to check.
|
|
1786
|
+
* @returns {value is undefined} Returns `true` if the value is `undefined`, otherwise `false`.
|
|
1787
|
+
* @example
|
|
1788
|
+
* isUndefined(undefined); // ➔ true
|
|
1789
|
+
* isUndefined([]); // ➔ false
|
|
1790
|
+
* isUndefined(123); // ➔ false
|
|
1791
|
+
* isUndefined(null); // ➔ false
|
|
1792
|
+
* isUndefined("abc"); // ➔ false
|
|
1793
|
+
*/
|
|
1794
|
+
declare const isUndefined:(value:unknown)=>value is undefined;
|
|
1795
|
+
/** ---------------------------------
|
|
1796
|
+
* * ***Validates whether a given string is a properly formatted URL.***
|
|
1797
|
+
* ---------------------------------------------------------
|
|
1798
|
+
*
|
|
1799
|
+
* Ensures that the input is:
|
|
1800
|
+
* - A non-empty string.
|
|
1801
|
+
* - A valid **[URL](https://developer.mozilla.org/docs/Web/API/URL)** with `http://` or `https://` scheme.
|
|
1802
|
+
*
|
|
1803
|
+
* @description
|
|
1804
|
+
* - ✅ Includes decoding for percent-encoded URLs (e.g., `https%3A%2F%2F...`).
|
|
1805
|
+
* - ❌ Rejects invalid strings, unsupported schemes, and malformed domains.
|
|
1806
|
+
*
|
|
1807
|
+
* @param {*} url - The value to validate.
|
|
1808
|
+
* @returns {boolean} Return `true` if the value is a **valid URL string**, otherwise `false`.
|
|
1809
|
+
* @example
|
|
1810
|
+
* isValidURL("https://example.com");
|
|
1811
|
+
* // ➔ true
|
|
1812
|
+
*
|
|
1813
|
+
* isValidURL("ftp://example.com");
|
|
1814
|
+
* // ➔ false
|
|
1815
|
+
*
|
|
1816
|
+
* isValidURL("not-a-url");
|
|
1817
|
+
* // ➔ false
|
|
1818
|
+
*/
|
|
1819
|
+
declare const isValidURL:(url:unknown)=>boolean;
|
|
1820
|
+
/** --------------------------------------------------
|
|
1821
|
+
* * ***Type guard: `isWeakMap`.***
|
|
1822
|
+
* ----------------------------------------------------------
|
|
1823
|
+
* @description Checks if a value is a **[`WeakMap`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/WeakMap/WeakMap)** object.
|
|
1824
|
+
*
|
|
1825
|
+
* - Narrows type to `WeakMap<K, V>` when true.
|
|
1826
|
+
* - Excludes `Map`, arrays, plain objects, and other non-WeakMap values.
|
|
1827
|
+
*
|
|
1828
|
+
* @template K - Keys must be objects.
|
|
1829
|
+
* @template V - Type of values stored in the WeakMap.
|
|
1830
|
+
* @param {*} value - The value to check.
|
|
1831
|
+
* @returns {boolean} Returns `true` if the value is a `WeakMap`, otherwise `false`.
|
|
1832
|
+
* @example
|
|
1833
|
+
*
|
|
1834
|
+
* isWeakMap(new WeakMap);
|
|
1835
|
+
* // ➔ true
|
|
1836
|
+
* isWeakMap(new Map);
|
|
1837
|
+
* // ➔ false
|
|
1838
|
+
*/
|
|
1839
|
+
declare function isWeakMap<K extends object=object,V=unknown>(value:unknown):value is WeakMap<K,V>;export{type IsArrayResult,IsPlainObjectResult,areArraysEqual,areObjectsEqual,areURLsEqualPath,areURLsIdentical,arrayHasAnyMatch,doesKeyExist,hasOwnProp,isArguments,isArray,isArrayBuffer,isArrayLike,isArrayLikeObject,isBigInt,isBoolean,isBuffer,isCurrencyLike,isDate,isDeepEqual,isElement,isEmpty,isEmptyArray,isEmptyDeep,isEmptyObject,isEmptyString,isEmptyValue,isEqual,isEqualWith,isError,isFinite,isFunction,isInteger,isLength,isMap,isMatch,isMatchWith,isNaN,isNative,isNil,isNonEmptyArray,isNonEmptyString,isNonEmptyValue,isNull,isObject,isObjectLoose,isObjectOrArray,isRegExp,isSafeInteger,isSet,isString,isSymbol,isTypedArray,isURL,isUndefined,isValidURL,isWeakMap,textContainsAll,textContainsAny};
|