@xylabs/typeof 5.0.84 → 5.0.86
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/README.md +605 -687
- package/package.json +3 -3
package/README.md
CHANGED
|
@@ -15,6 +15,8 @@
|
|
|
15
15
|
|
|
16
16
|
Base functionality used throughout XY Labs TypeScript/JavaScript libraries
|
|
17
17
|
|
|
18
|
+
|
|
19
|
+
|
|
18
20
|
## Reference
|
|
19
21
|
|
|
20
22
|
**@xylabs/typeof**
|
|
@@ -23,64 +25,68 @@ Base functionality used throughout XY Labs TypeScript/JavaScript libraries
|
|
|
23
25
|
|
|
24
26
|
## Type Aliases
|
|
25
27
|
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
28
|
+
| Type Alias | Description |
|
|
29
|
+
| ------ | ------ |
|
|
30
|
+
| [Brand](#type-aliases/Brand) | Creates a branded type by intersecting base type T with brand type B, enabling nominal typing in TypeScript. |
|
|
31
|
+
| [IdentityFunction](#type-aliases/IdentityFunction) | A type guard function that narrows an unknown value to type T. |
|
|
32
|
+
| [FieldType](#type-aliases/FieldType) | Union of string literals representing the possible types of an object field. |
|
|
33
|
+
| [ObjectTypeShape](#type-aliases/ObjectTypeShape) | Describes the expected shape of an object by mapping each key to its expected field type. |
|
|
34
|
+
| [TypeOfTypes](#type-aliases/TypeOfTypes) | Union of string literals representing the possible results of the extended `typeOf` function. |
|
|
35
|
+
| [TypedValue](#type-aliases/TypedValue) | A value that can appear in a typed object tree (primitives, objects, arrays, functions, and symbols). |
|
|
36
|
+
| [TypedKey](#type-aliases/TypedKey) | A valid key for a typed object. Defaults to string | number | symbol unless narrowed by T. |
|
|
37
|
+
| [TypedObject](#type-aliases/TypedObject) | An object whose keys are TypedKey and whose values are TypedValue. |
|
|
38
|
+
| [TypedArray](#type-aliases/TypedArray) | An array of TypedValue elements. |
|
|
39
|
+
| [AnyFunction](#type-aliases/AnyFunction) | A function type that accepts any arguments and returns unknown. |
|
|
40
|
+
| [RecordKey](#type-aliases/RecordKey) | A union of valid object key types. |
|
|
37
41
|
|
|
38
42
|
## Functions
|
|
39
43
|
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
44
|
+
| Function | Description |
|
|
45
|
+
| ------ | ------ |
|
|
46
|
+
| [isTypedKey](#functions/isTypedKey) | Type guard that checks whether a value is a valid TypedKey (string, bigint, number, or symbol). |
|
|
47
|
+
| [isTypedValue](#functions/isTypedValue) | Type guard that checks whether a value is a valid TypedValue. |
|
|
48
|
+
| [isTypedArray](#functions/isTypedArray) | Type guard that checks whether a value is a TypedArray (an array where every element is a TypedValue). |
|
|
49
|
+
| [isValidTypedFieldPair](#functions/isValidTypedFieldPair) | Type guard that checks whether a key-value pair has a valid TypedKey and TypedValue. |
|
|
50
|
+
| [isTypedObject](#functions/isTypedObject) | Type guard that checks whether a value is a TypedObject (an object with TypedKey keys and TypedValue values). |
|
|
51
|
+
| [ifDefined](#functions/ifDefined) | Invokes the callback only if the value is neither null nor undefined. |
|
|
52
|
+
| [ifTypeOf](#functions/ifTypeOf) | Invokes the callback if the value matches the specified type, with an optional additional predicate. |
|
|
53
|
+
| [isUndefined](#functions/isUndefined) | Type guard that checks whether a value is undefined. |
|
|
54
|
+
| [isDefined](#functions/isDefined) | Type guard that checks whether a value is not undefined. |
|
|
55
|
+
| [isNull](#functions/isNull) | Type guard that checks whether a value is null. |
|
|
56
|
+
| [isDefinedNotNull](#functions/isDefinedNotNull) | Type guard that checks whether a value is neither undefined nor null. |
|
|
57
|
+
| [isUndefinedOrNull](#functions/isUndefinedOrNull) | Type guard that checks whether a value is undefined or null. |
|
|
58
|
+
| [isBigInt](#functions/isBigInt) | Type guard that checks whether a value is a bigint. |
|
|
59
|
+
| [isString](#functions/isString) | Type guard that checks whether a value is a string. |
|
|
60
|
+
| [isNumber](#functions/isNumber) | Type guard that checks whether a value is a number. |
|
|
61
|
+
| [isObject](#functions/isObject) | Type guard that checks whether a value is a plain object (not null and not an array). |
|
|
62
|
+
| [isArray](#functions/isArray) | Type guard that checks whether a value is an array. |
|
|
63
|
+
| [isFunction](#functions/isFunction) | Type guard that checks whether a value is a function. |
|
|
64
|
+
| [isSymbol](#functions/isSymbol) | Type guard that checks whether a value is a symbol. |
|
|
65
|
+
| [isEmptyObject](#functions/isEmptyObject) | Type guard that checks whether a value is an object with no own keys. |
|
|
66
|
+
| [isEmptyString](#functions/isEmptyString) | Type guard that checks whether a value is an empty string. |
|
|
67
|
+
| [isEmptyArray](#functions/isEmptyArray) | Type guard that checks whether a value is an empty array. |
|
|
68
|
+
| [isPopulatedArray](#functions/isPopulatedArray) | Type guard that checks whether a value is a non-empty array. |
|
|
69
|
+
| [isEmpty](#functions/isEmpty) | Type guard that checks whether a value is empty (empty string, empty array, or empty object). |
|
|
70
|
+
| [isFalsy](#functions/isFalsy) | Type guard that checks whether a value is falsy (0, null, undefined, false, '', or 0n). |
|
|
71
|
+
| [isTruthy](#functions/isTruthy) | Type guard that checks whether a value is truthy (not 0, null, undefined, false, '', or 0n). |
|
|
72
|
+
| [isBoolean](#functions/isBoolean) | Type guard that checks whether a value is a boolean. |
|
|
73
|
+
| [isDateString](#functions/isDateString) | Type guard that checks whether a value is a string that can be parsed as a valid date. |
|
|
74
|
+
| [isDate](#functions/isDate) | Type guard that checks whether a value is a Date instance. |
|
|
75
|
+
| [isRegExp](#functions/isRegExp) | Type guard that checks whether a value is a RegExp instance. |
|
|
76
|
+
| [isError](#functions/isError) | Type guard that checks whether a value is an Error instance. |
|
|
77
|
+
| [isPromise](#functions/isPromise) | Type guard that checks whether a value is a Promise instance. |
|
|
78
|
+
| [isPromiseLike](#functions/isPromiseLike) | Type guard that checks whether a value is promise-like (has a `then` method). |
|
|
79
|
+
| [isMap](#functions/isMap) | Type guard that checks whether a value is a Map instance. |
|
|
80
|
+
| [isArrayBufferView](#functions/isArrayBufferView) | Type guard that checks whether a value is an ArrayBufferView (e.g., TypedArray or DataView). |
|
|
81
|
+
| [isSet](#functions/isSet) | Type guard that checks whether a value is a Set instance. |
|
|
82
|
+
| [isWeakMap](#functions/isWeakMap) | Type guard that checks whether a value is a WeakMap instance. |
|
|
83
|
+
| [isWeakSet](#functions/isWeakSet) | Type guard that checks whether a value is a WeakSet instance. |
|
|
84
|
+
| [isDataView](#functions/isDataView) | Type guard that checks whether a value is a DataView instance. |
|
|
85
|
+
| [isBlob](#functions/isBlob) | Type guard that checks whether a value is a Blob instance. |
|
|
86
|
+
| [isFile](#functions/isFile) | Type guard that checks whether a value is a File instance. |
|
|
87
|
+
| [isType](#functions/isType) | Checks whether a value matches the expected field type, with correct handling for arrays and nulls. |
|
|
88
|
+
| [typeOf](#functions/typeOf) | Extended typeof that distinguishes arrays from objects (unlike native `typeof`). |
|
|
89
|
+
| [validateType](#functions/validateType) | Validates that a value matches the expected type, returning the value and any errors. |
|
|
84
90
|
|
|
85
91
|
### functions
|
|
86
92
|
|
|
@@ -91,30 +97,23 @@ Base functionality used throughout XY Labs TypeScript/JavaScript libraries
|
|
|
91
97
|
***
|
|
92
98
|
|
|
93
99
|
```ts
|
|
94
|
-
function ifDefined<T>(value, func): T | undefined;
|
|
100
|
+
function ifDefined<T>(value: T, func: (value: T) => void): T | undefined;
|
|
95
101
|
```
|
|
96
102
|
|
|
97
103
|
Invokes the callback only if the value is neither null nor undefined.
|
|
98
104
|
|
|
99
105
|
## Type Parameters
|
|
100
106
|
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
`T`
|
|
107
|
+
| Type Parameter |
|
|
108
|
+
| ------ |
|
|
109
|
+
| `T` |
|
|
104
110
|
|
|
105
111
|
## Parameters
|
|
106
112
|
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
`T`
|
|
110
|
-
|
|
111
|
-
The value to check.
|
|
112
|
-
|
|
113
|
-
### func
|
|
114
|
-
|
|
115
|
-
(`value`) => `void`
|
|
116
|
-
|
|
117
|
-
The callback to invoke with the value if it is defined.
|
|
113
|
+
| Parameter | Type | Description |
|
|
114
|
+
| ------ | ------ | ------ |
|
|
115
|
+
| `value` | `T` | The value to check. |
|
|
116
|
+
| `func` | (`value`: `T`) => `void` | The callback to invoke with the value if it is defined. |
|
|
118
117
|
|
|
119
118
|
## Returns
|
|
120
119
|
|
|
@@ -130,49 +129,29 @@ The value if defined, or undefined otherwise.
|
|
|
130
129
|
|
|
131
130
|
```ts
|
|
132
131
|
function ifTypeOf<T, R>(
|
|
133
|
-
typeName,
|
|
134
|
-
value,
|
|
135
|
-
trueFunc,
|
|
136
|
-
isFunc
|
|
132
|
+
typeName: TypeOfTypes,
|
|
133
|
+
value: unknown,
|
|
134
|
+
trueFunc: (value: T) => R,
|
|
135
|
+
isFunc?: (value: T) => boolean): R | undefined;
|
|
137
136
|
```
|
|
138
137
|
|
|
139
138
|
Invokes the callback if the value matches the specified type, with an optional additional predicate.
|
|
140
139
|
|
|
141
140
|
## Type Parameters
|
|
142
141
|
|
|
143
|
-
|
|
144
|
-
|
|
145
|
-
`T`
|
|
146
|
-
|
|
147
|
-
### R
|
|
148
|
-
|
|
149
|
-
`R`
|
|
142
|
+
| Type Parameter |
|
|
143
|
+
| ------ |
|
|
144
|
+
| `T` |
|
|
145
|
+
| `R` |
|
|
150
146
|
|
|
151
147
|
## Parameters
|
|
152
148
|
|
|
153
|
-
|
|
154
|
-
|
|
155
|
-
[`TypeOfTypes`](#../type-aliases/TypeOfTypes)
|
|
156
|
-
|
|
157
|
-
|
|
158
|
-
|
|
159
|
-
### value
|
|
160
|
-
|
|
161
|
-
`unknown`
|
|
162
|
-
|
|
163
|
-
The value to check.
|
|
164
|
-
|
|
165
|
-
### trueFunc
|
|
166
|
-
|
|
167
|
-
(`value`) => `R`
|
|
168
|
-
|
|
169
|
-
The callback to invoke if the type matches.
|
|
170
|
-
|
|
171
|
-
### isFunc?
|
|
172
|
-
|
|
173
|
-
(`value`) => `boolean`
|
|
174
|
-
|
|
175
|
-
Optional additional predicate that must also return true.
|
|
149
|
+
| Parameter | Type | Description |
|
|
150
|
+
| ------ | ------ | ------ |
|
|
151
|
+
| `typeName` | [`TypeOfTypes`](#../type-aliases/TypeOfTypes) | The expected type name to match against. |
|
|
152
|
+
| `value` | `unknown` | The value to check. |
|
|
153
|
+
| `trueFunc` | (`value`: `T`) => `R` | The callback to invoke if the type matches. |
|
|
154
|
+
| `isFunc?` | (`value`: `T`) => `boolean` | Optional additional predicate that must also return true. |
|
|
176
155
|
|
|
177
156
|
## Returns
|
|
178
157
|
|
|
@@ -189,16 +168,16 @@ The result of trueFunc if the type matches (and isFunc passes), or undefined.
|
|
|
189
168
|
## Call Signature
|
|
190
169
|
|
|
191
170
|
```ts
|
|
192
|
-
function isArray(value): value is readonly unknown[];
|
|
171
|
+
function isArray(value: unknown): value is readonly unknown[];
|
|
193
172
|
```
|
|
194
173
|
|
|
195
174
|
Type guard that checks whether a value is an array.
|
|
196
175
|
|
|
197
176
|
### Parameters
|
|
198
177
|
|
|
199
|
-
|
|
200
|
-
|
|
201
|
-
`unknown`
|
|
178
|
+
| Parameter | Type |
|
|
179
|
+
| ------ | ------ |
|
|
180
|
+
| `value` | `unknown` |
|
|
202
181
|
|
|
203
182
|
### Returns
|
|
204
183
|
|
|
@@ -207,22 +186,22 @@ Type guard that checks whether a value is an array.
|
|
|
207
186
|
## Call Signature
|
|
208
187
|
|
|
209
188
|
```ts
|
|
210
|
-
function isArray<T>(value): value is Extract<T, readonly unknown[]>;
|
|
189
|
+
function isArray<T>(value: T): value is Extract<T, readonly unknown[]>;
|
|
211
190
|
```
|
|
212
191
|
|
|
213
192
|
Type guard that checks whether a value is an array.
|
|
214
193
|
|
|
215
194
|
### Type Parameters
|
|
216
195
|
|
|
217
|
-
|
|
218
|
-
|
|
219
|
-
`T`
|
|
196
|
+
| Type Parameter |
|
|
197
|
+
| ------ |
|
|
198
|
+
| `T` |
|
|
220
199
|
|
|
221
200
|
### Parameters
|
|
222
201
|
|
|
223
|
-
|
|
224
|
-
|
|
225
|
-
`T`
|
|
202
|
+
| Parameter | Type |
|
|
203
|
+
| ------ | ------ |
|
|
204
|
+
| `value` | `T` |
|
|
226
205
|
|
|
227
206
|
### Returns
|
|
228
207
|
|
|
@@ -237,16 +216,16 @@ Type guard that checks whether a value is an array.
|
|
|
237
216
|
## Call Signature
|
|
238
217
|
|
|
239
218
|
```ts
|
|
240
|
-
function isArrayBufferView(value): value is ArrayBufferView<ArrayBufferLike>;
|
|
219
|
+
function isArrayBufferView(value: unknown): value is ArrayBufferView<ArrayBufferLike>;
|
|
241
220
|
```
|
|
242
221
|
|
|
243
222
|
Type guard that checks whether a value is an ArrayBufferView (e.g., TypedArray or DataView).
|
|
244
223
|
|
|
245
224
|
### Parameters
|
|
246
225
|
|
|
247
|
-
|
|
248
|
-
|
|
249
|
-
`unknown`
|
|
226
|
+
| Parameter | Type |
|
|
227
|
+
| ------ | ------ |
|
|
228
|
+
| `value` | `unknown` |
|
|
250
229
|
|
|
251
230
|
### Returns
|
|
252
231
|
|
|
@@ -255,22 +234,22 @@ Type guard that checks whether a value is an ArrayBufferView (e.g., TypedArray o
|
|
|
255
234
|
## Call Signature
|
|
256
235
|
|
|
257
236
|
```ts
|
|
258
|
-
function isArrayBufferView<T>(value): value is Extract<T, ArrayBufferView<ArrayBufferLike>>;
|
|
237
|
+
function isArrayBufferView<T>(value: T): value is Extract<T, ArrayBufferView<ArrayBufferLike>>;
|
|
259
238
|
```
|
|
260
239
|
|
|
261
240
|
Type guard that checks whether a value is an ArrayBufferView (e.g., TypedArray or DataView).
|
|
262
241
|
|
|
263
242
|
### Type Parameters
|
|
264
243
|
|
|
265
|
-
|
|
266
|
-
|
|
267
|
-
`T` *extends* `ArrayBufferView`\<`ArrayBufferLike`\>
|
|
244
|
+
| Type Parameter |
|
|
245
|
+
| ------ |
|
|
246
|
+
| `T` *extends* `ArrayBufferView`\<`ArrayBufferLike`\> |
|
|
268
247
|
|
|
269
248
|
### Parameters
|
|
270
249
|
|
|
271
|
-
|
|
272
|
-
|
|
273
|
-
`T`
|
|
250
|
+
| Parameter | Type |
|
|
251
|
+
| ------ | ------ |
|
|
252
|
+
| `value` | `T` |
|
|
274
253
|
|
|
275
254
|
### Returns
|
|
276
255
|
|
|
@@ -285,16 +264,16 @@ Type guard that checks whether a value is an ArrayBufferView (e.g., TypedArray o
|
|
|
285
264
|
## Call Signature
|
|
286
265
|
|
|
287
266
|
```ts
|
|
288
|
-
function isBigInt(value): value is bigint;
|
|
267
|
+
function isBigInt(value: unknown): value is bigint;
|
|
289
268
|
```
|
|
290
269
|
|
|
291
270
|
Type guard that checks whether a value is a bigint.
|
|
292
271
|
|
|
293
272
|
### Parameters
|
|
294
273
|
|
|
295
|
-
|
|
296
|
-
|
|
297
|
-
`unknown`
|
|
274
|
+
| Parameter | Type |
|
|
275
|
+
| ------ | ------ |
|
|
276
|
+
| `value` | `unknown` |
|
|
298
277
|
|
|
299
278
|
### Returns
|
|
300
279
|
|
|
@@ -303,22 +282,22 @@ Type guard that checks whether a value is a bigint.
|
|
|
303
282
|
## Call Signature
|
|
304
283
|
|
|
305
284
|
```ts
|
|
306
|
-
function isBigInt<T>(value): value is Extract<T, bigint>;
|
|
285
|
+
function isBigInt<T>(value: T): value is Extract<T, bigint>;
|
|
307
286
|
```
|
|
308
287
|
|
|
309
288
|
Type guard that checks whether a value is a bigint.
|
|
310
289
|
|
|
311
290
|
### Type Parameters
|
|
312
291
|
|
|
313
|
-
|
|
314
|
-
|
|
315
|
-
`T` *extends* `bigint`
|
|
292
|
+
| Type Parameter |
|
|
293
|
+
| ------ |
|
|
294
|
+
| `T` *extends* `bigint` |
|
|
316
295
|
|
|
317
296
|
### Parameters
|
|
318
297
|
|
|
319
|
-
|
|
320
|
-
|
|
321
|
-
`T`
|
|
298
|
+
| Parameter | Type |
|
|
299
|
+
| ------ | ------ |
|
|
300
|
+
| `value` | `T` |
|
|
322
301
|
|
|
323
302
|
### Returns
|
|
324
303
|
|
|
@@ -333,16 +312,16 @@ Type guard that checks whether a value is a bigint.
|
|
|
333
312
|
## Call Signature
|
|
334
313
|
|
|
335
314
|
```ts
|
|
336
|
-
function isBlob(value): value is Blob;
|
|
315
|
+
function isBlob(value: unknown): value is Blob;
|
|
337
316
|
```
|
|
338
317
|
|
|
339
318
|
Type guard that checks whether a value is a Blob instance.
|
|
340
319
|
|
|
341
320
|
### Parameters
|
|
342
321
|
|
|
343
|
-
|
|
344
|
-
|
|
345
|
-
`unknown`
|
|
322
|
+
| Parameter | Type |
|
|
323
|
+
| ------ | ------ |
|
|
324
|
+
| `value` | `unknown` |
|
|
346
325
|
|
|
347
326
|
### Returns
|
|
348
327
|
|
|
@@ -351,22 +330,22 @@ Type guard that checks whether a value is a Blob instance.
|
|
|
351
330
|
## Call Signature
|
|
352
331
|
|
|
353
332
|
```ts
|
|
354
|
-
function isBlob<T>(value): value is Extract<T, Blob>;
|
|
333
|
+
function isBlob<T>(value: T): value is Extract<T, Blob>;
|
|
355
334
|
```
|
|
356
335
|
|
|
357
336
|
Type guard that checks whether a value is a Blob instance.
|
|
358
337
|
|
|
359
338
|
### Type Parameters
|
|
360
339
|
|
|
361
|
-
|
|
362
|
-
|
|
363
|
-
`T` *extends* `Blob`
|
|
340
|
+
| Type Parameter |
|
|
341
|
+
| ------ |
|
|
342
|
+
| `T` *extends* `Blob` |
|
|
364
343
|
|
|
365
344
|
### Parameters
|
|
366
345
|
|
|
367
|
-
|
|
368
|
-
|
|
369
|
-
`T`
|
|
346
|
+
| Parameter | Type |
|
|
347
|
+
| ------ | ------ |
|
|
348
|
+
| `value` | `T` |
|
|
370
349
|
|
|
371
350
|
### Returns
|
|
372
351
|
|
|
@@ -381,16 +360,16 @@ Type guard that checks whether a value is a Blob instance.
|
|
|
381
360
|
## Call Signature
|
|
382
361
|
|
|
383
362
|
```ts
|
|
384
|
-
function isBoolean(value): value is boolean;
|
|
363
|
+
function isBoolean(value: unknown): value is boolean;
|
|
385
364
|
```
|
|
386
365
|
|
|
387
366
|
Type guard that checks whether a value is a boolean.
|
|
388
367
|
|
|
389
368
|
### Parameters
|
|
390
369
|
|
|
391
|
-
|
|
392
|
-
|
|
393
|
-
`unknown`
|
|
370
|
+
| Parameter | Type |
|
|
371
|
+
| ------ | ------ |
|
|
372
|
+
| `value` | `unknown` |
|
|
394
373
|
|
|
395
374
|
### Returns
|
|
396
375
|
|
|
@@ -399,22 +378,22 @@ Type guard that checks whether a value is a boolean.
|
|
|
399
378
|
## Call Signature
|
|
400
379
|
|
|
401
380
|
```ts
|
|
402
|
-
function isBoolean<T>(value): value is Extract<T, boolean>;
|
|
381
|
+
function isBoolean<T>(value: T): value is Extract<T, boolean>;
|
|
403
382
|
```
|
|
404
383
|
|
|
405
384
|
Type guard that checks whether a value is a boolean.
|
|
406
385
|
|
|
407
386
|
### Type Parameters
|
|
408
387
|
|
|
409
|
-
|
|
410
|
-
|
|
411
|
-
`T` *extends* `boolean`
|
|
388
|
+
| Type Parameter |
|
|
389
|
+
| ------ |
|
|
390
|
+
| `T` *extends* `boolean` |
|
|
412
391
|
|
|
413
392
|
### Parameters
|
|
414
393
|
|
|
415
|
-
|
|
416
|
-
|
|
417
|
-
`T`
|
|
394
|
+
| Parameter | Type |
|
|
395
|
+
| ------ | ------ |
|
|
396
|
+
| `value` | `T` |
|
|
418
397
|
|
|
419
398
|
### Returns
|
|
420
399
|
|
|
@@ -429,16 +408,16 @@ Type guard that checks whether a value is a boolean.
|
|
|
429
408
|
## Call Signature
|
|
430
409
|
|
|
431
410
|
```ts
|
|
432
|
-
function isDataView(value): value is DataView<ArrayBufferLike>;
|
|
411
|
+
function isDataView(value: unknown): value is DataView<ArrayBufferLike>;
|
|
433
412
|
```
|
|
434
413
|
|
|
435
414
|
Type guard that checks whether a value is a DataView instance.
|
|
436
415
|
|
|
437
416
|
### Parameters
|
|
438
417
|
|
|
439
|
-
|
|
440
|
-
|
|
441
|
-
`unknown`
|
|
418
|
+
| Parameter | Type |
|
|
419
|
+
| ------ | ------ |
|
|
420
|
+
| `value` | `unknown` |
|
|
442
421
|
|
|
443
422
|
### Returns
|
|
444
423
|
|
|
@@ -447,22 +426,22 @@ Type guard that checks whether a value is a DataView instance.
|
|
|
447
426
|
## Call Signature
|
|
448
427
|
|
|
449
428
|
```ts
|
|
450
|
-
function isDataView<T>(value): value is Extract<T, DataView<ArrayBufferLike>>;
|
|
429
|
+
function isDataView<T>(value: T): value is Extract<T, DataView<ArrayBufferLike>>;
|
|
451
430
|
```
|
|
452
431
|
|
|
453
432
|
Type guard that checks whether a value is a DataView instance.
|
|
454
433
|
|
|
455
434
|
### Type Parameters
|
|
456
435
|
|
|
457
|
-
|
|
458
|
-
|
|
459
|
-
`T`
|
|
436
|
+
| Type Parameter |
|
|
437
|
+
| ------ |
|
|
438
|
+
| `T` |
|
|
460
439
|
|
|
461
440
|
### Parameters
|
|
462
441
|
|
|
463
|
-
|
|
464
|
-
|
|
465
|
-
`T`
|
|
442
|
+
| Parameter | Type |
|
|
443
|
+
| ------ | ------ |
|
|
444
|
+
| `value` | `T` |
|
|
466
445
|
|
|
467
446
|
### Returns
|
|
468
447
|
|
|
@@ -477,16 +456,16 @@ Type guard that checks whether a value is a DataView instance.
|
|
|
477
456
|
## Call Signature
|
|
478
457
|
|
|
479
458
|
```ts
|
|
480
|
-
function isDate(value): value is Date;
|
|
459
|
+
function isDate(value: unknown): value is Date;
|
|
481
460
|
```
|
|
482
461
|
|
|
483
462
|
Type guard that checks whether a value is a Date instance.
|
|
484
463
|
|
|
485
464
|
### Parameters
|
|
486
465
|
|
|
487
|
-
|
|
488
|
-
|
|
489
|
-
`unknown`
|
|
466
|
+
| Parameter | Type |
|
|
467
|
+
| ------ | ------ |
|
|
468
|
+
| `value` | `unknown` |
|
|
490
469
|
|
|
491
470
|
### Returns
|
|
492
471
|
|
|
@@ -495,22 +474,22 @@ Type guard that checks whether a value is a Date instance.
|
|
|
495
474
|
## Call Signature
|
|
496
475
|
|
|
497
476
|
```ts
|
|
498
|
-
function isDate<T>(value): value is Extract<T, Date>;
|
|
477
|
+
function isDate<T>(value: T): value is Extract<T, Date>;
|
|
499
478
|
```
|
|
500
479
|
|
|
501
480
|
Type guard that checks whether a value is a Date instance.
|
|
502
481
|
|
|
503
482
|
### Type Parameters
|
|
504
483
|
|
|
505
|
-
|
|
506
|
-
|
|
507
|
-
`T`
|
|
484
|
+
| Type Parameter |
|
|
485
|
+
| ------ |
|
|
486
|
+
| `T` |
|
|
508
487
|
|
|
509
488
|
### Parameters
|
|
510
489
|
|
|
511
|
-
|
|
512
|
-
|
|
513
|
-
`T`
|
|
490
|
+
| Parameter | Type |
|
|
491
|
+
| ------ | ------ |
|
|
492
|
+
| `value` | `T` |
|
|
514
493
|
|
|
515
494
|
### Returns
|
|
516
495
|
|
|
@@ -525,16 +504,16 @@ Type guard that checks whether a value is a Date instance.
|
|
|
525
504
|
## Call Signature
|
|
526
505
|
|
|
527
506
|
```ts
|
|
528
|
-
function isDateString(value): value is string;
|
|
507
|
+
function isDateString(value: unknown): value is string;
|
|
529
508
|
```
|
|
530
509
|
|
|
531
510
|
Type guard that checks whether a value is a string that can be parsed as a valid date.
|
|
532
511
|
|
|
533
512
|
### Parameters
|
|
534
513
|
|
|
535
|
-
|
|
536
|
-
|
|
537
|
-
`unknown`
|
|
514
|
+
| Parameter | Type |
|
|
515
|
+
| ------ | ------ |
|
|
516
|
+
| `value` | `unknown` |
|
|
538
517
|
|
|
539
518
|
### Returns
|
|
540
519
|
|
|
@@ -543,22 +522,22 @@ Type guard that checks whether a value is a string that can be parsed as a valid
|
|
|
543
522
|
## Call Signature
|
|
544
523
|
|
|
545
524
|
```ts
|
|
546
|
-
function isDateString<T>(value): value is Extract<T, string>;
|
|
525
|
+
function isDateString<T>(value: T): value is Extract<T, string>;
|
|
547
526
|
```
|
|
548
527
|
|
|
549
528
|
Type guard that checks whether a value is a string that can be parsed as a valid date.
|
|
550
529
|
|
|
551
530
|
### Type Parameters
|
|
552
531
|
|
|
553
|
-
|
|
554
|
-
|
|
555
|
-
`T`
|
|
532
|
+
| Type Parameter |
|
|
533
|
+
| ------ |
|
|
534
|
+
| `T` |
|
|
556
535
|
|
|
557
536
|
### Parameters
|
|
558
537
|
|
|
559
|
-
|
|
560
|
-
|
|
561
|
-
`T`
|
|
538
|
+
| Parameter | Type |
|
|
539
|
+
| ------ | ------ |
|
|
540
|
+
| `value` | `T` |
|
|
562
541
|
|
|
563
542
|
### Returns
|
|
564
543
|
|
|
@@ -571,22 +550,22 @@ Type guard that checks whether a value is a string that can be parsed as a valid
|
|
|
571
550
|
***
|
|
572
551
|
|
|
573
552
|
```ts
|
|
574
|
-
function isDefined<T>(value): value is Exclude<T, undefined>;
|
|
553
|
+
function isDefined<T>(value: T): value is Exclude<T, undefined>;
|
|
575
554
|
```
|
|
576
555
|
|
|
577
556
|
Type guard that checks whether a value is not undefined.
|
|
578
557
|
|
|
579
558
|
## Type Parameters
|
|
580
559
|
|
|
581
|
-
|
|
582
|
-
|
|
583
|
-
`T`
|
|
560
|
+
| Type Parameter |
|
|
561
|
+
| ------ |
|
|
562
|
+
| `T` |
|
|
584
563
|
|
|
585
564
|
## Parameters
|
|
586
565
|
|
|
587
|
-
|
|
588
|
-
|
|
589
|
-
`T`
|
|
566
|
+
| Parameter | Type |
|
|
567
|
+
| ------ | ------ |
|
|
568
|
+
| `value` | `T` |
|
|
590
569
|
|
|
591
570
|
## Returns
|
|
592
571
|
|
|
@@ -599,22 +578,22 @@ Type guard that checks whether a value is not undefined.
|
|
|
599
578
|
***
|
|
600
579
|
|
|
601
580
|
```ts
|
|
602
|
-
function isDefinedNotNull<T>(value): value is Exclude<T, null | undefined>;
|
|
581
|
+
function isDefinedNotNull<T>(value: T): value is Exclude<T, null | undefined>;
|
|
603
582
|
```
|
|
604
583
|
|
|
605
584
|
Type guard that checks whether a value is neither undefined nor null.
|
|
606
585
|
|
|
607
586
|
## Type Parameters
|
|
608
587
|
|
|
609
|
-
|
|
610
|
-
|
|
611
|
-
`T`
|
|
588
|
+
| Type Parameter |
|
|
589
|
+
| ------ |
|
|
590
|
+
| `T` |
|
|
612
591
|
|
|
613
592
|
## Parameters
|
|
614
593
|
|
|
615
|
-
|
|
616
|
-
|
|
617
|
-
`T`
|
|
594
|
+
| Parameter | Type |
|
|
595
|
+
| ------ | ------ |
|
|
596
|
+
| `value` | `T` |
|
|
618
597
|
|
|
619
598
|
## Returns
|
|
620
599
|
|
|
@@ -629,22 +608,22 @@ value is Exclude\<T, null \| undefined\>
|
|
|
629
608
|
## Call Signature
|
|
630
609
|
|
|
631
610
|
```ts
|
|
632
|
-
function isEmpty<T>(value): value is T;
|
|
611
|
+
function isEmpty<T>(value: unknown): value is T;
|
|
633
612
|
```
|
|
634
613
|
|
|
635
614
|
Type guard that checks whether a value is empty (empty string, empty array, or empty object).
|
|
636
615
|
|
|
637
616
|
### Type Parameters
|
|
638
617
|
|
|
639
|
-
|
|
640
|
-
|
|
641
|
-
`T`
|
|
618
|
+
| Type Parameter |
|
|
619
|
+
| ------ |
|
|
620
|
+
| `T` |
|
|
642
621
|
|
|
643
622
|
### Parameters
|
|
644
623
|
|
|
645
|
-
|
|
646
|
-
|
|
647
|
-
`unknown`
|
|
624
|
+
| Parameter | Type |
|
|
625
|
+
| ------ | ------ |
|
|
626
|
+
| `value` | `unknown` |
|
|
648
627
|
|
|
649
628
|
### Returns
|
|
650
629
|
|
|
@@ -653,30 +632,24 @@ Type guard that checks whether a value is empty (empty string, empty array, or e
|
|
|
653
632
|
## Call Signature
|
|
654
633
|
|
|
655
634
|
```ts
|
|
656
|
-
function isEmpty<K, V, T>(value): value is Extract<T, Record<K, never>>;
|
|
635
|
+
function isEmpty<K, V, T>(value: T): value is Extract<T, Record<K, never>>;
|
|
657
636
|
```
|
|
658
637
|
|
|
659
638
|
Type guard that checks whether a value is empty (empty string, empty array, or empty object).
|
|
660
639
|
|
|
661
640
|
### Type Parameters
|
|
662
641
|
|
|
663
|
-
|
|
664
|
-
|
|
665
|
-
`K` *extends* [`RecordKey`](#../type-aliases/RecordKey)
|
|
666
|
-
|
|
667
|
-
|
|
668
|
-
|
|
669
|
-
`V`
|
|
670
|
-
|
|
671
|
-
### T
|
|
672
|
-
|
|
673
|
-
`T` *extends* `Record`\<`K`, `V`\>
|
|
642
|
+
| Type Parameter |
|
|
643
|
+
| ------ |
|
|
644
|
+
| `K` *extends* [`RecordKey`](#../type-aliases/RecordKey) |
|
|
645
|
+
| `V` |
|
|
646
|
+
| `T` *extends* `Record`\<`K`, `V`\> |
|
|
674
647
|
|
|
675
648
|
### Parameters
|
|
676
649
|
|
|
677
|
-
|
|
678
|
-
|
|
679
|
-
`T`
|
|
650
|
+
| Parameter | Type |
|
|
651
|
+
| ------ | ------ |
|
|
652
|
+
| `value` | `T` |
|
|
680
653
|
|
|
681
654
|
### Returns
|
|
682
655
|
|
|
@@ -685,22 +658,22 @@ Type guard that checks whether a value is empty (empty string, empty array, or e
|
|
|
685
658
|
## Call Signature
|
|
686
659
|
|
|
687
660
|
```ts
|
|
688
|
-
function isEmpty<T>(value): value is Extract<T, never[]>;
|
|
661
|
+
function isEmpty<T>(value: T): value is Extract<T, never[]>;
|
|
689
662
|
```
|
|
690
663
|
|
|
691
664
|
Type guard that checks whether a value is empty (empty string, empty array, or empty object).
|
|
692
665
|
|
|
693
666
|
### Type Parameters
|
|
694
667
|
|
|
695
|
-
|
|
696
|
-
|
|
697
|
-
`T` *extends* `unknown`[]
|
|
668
|
+
| Type Parameter |
|
|
669
|
+
| ------ |
|
|
670
|
+
| `T` *extends* `unknown`[] |
|
|
698
671
|
|
|
699
672
|
### Parameters
|
|
700
673
|
|
|
701
|
-
|
|
702
|
-
|
|
703
|
-
`T`
|
|
674
|
+
| Parameter | Type |
|
|
675
|
+
| ------ | ------ |
|
|
676
|
+
| `value` | `T` |
|
|
704
677
|
|
|
705
678
|
### Returns
|
|
706
679
|
|
|
@@ -715,16 +688,16 @@ Type guard that checks whether a value is empty (empty string, empty array, or e
|
|
|
715
688
|
## Call Signature
|
|
716
689
|
|
|
717
690
|
```ts
|
|
718
|
-
function isEmptyArray(value): value is [];
|
|
691
|
+
function isEmptyArray(value: unknown): value is [];
|
|
719
692
|
```
|
|
720
693
|
|
|
721
694
|
Type guard that checks whether a value is an empty array.
|
|
722
695
|
|
|
723
696
|
### Parameters
|
|
724
697
|
|
|
725
|
-
|
|
726
|
-
|
|
727
|
-
`unknown`
|
|
698
|
+
| Parameter | Type |
|
|
699
|
+
| ------ | ------ |
|
|
700
|
+
| `value` | `unknown` |
|
|
728
701
|
|
|
729
702
|
### Returns
|
|
730
703
|
|
|
@@ -733,22 +706,22 @@ Type guard that checks whether a value is an empty array.
|
|
|
733
706
|
## Call Signature
|
|
734
707
|
|
|
735
708
|
```ts
|
|
736
|
-
function isEmptyArray<T>(value): value is Extract<T, unknown[]>;
|
|
709
|
+
function isEmptyArray<T>(value: T): value is Extract<T, unknown[]>;
|
|
737
710
|
```
|
|
738
711
|
|
|
739
712
|
Type guard that checks whether a value is an empty array.
|
|
740
713
|
|
|
741
714
|
### Type Parameters
|
|
742
715
|
|
|
743
|
-
|
|
744
|
-
|
|
745
|
-
`T` *extends* `unknown`[]
|
|
716
|
+
| Type Parameter |
|
|
717
|
+
| ------ |
|
|
718
|
+
| `T` *extends* `unknown`[] |
|
|
746
719
|
|
|
747
720
|
### Parameters
|
|
748
721
|
|
|
749
|
-
|
|
750
|
-
|
|
751
|
-
`T`
|
|
722
|
+
| Parameter | Type |
|
|
723
|
+
| ------ | ------ |
|
|
724
|
+
| `value` | `T` |
|
|
752
725
|
|
|
753
726
|
### Returns
|
|
754
727
|
|
|
@@ -763,16 +736,16 @@ Type guard that checks whether a value is an empty array.
|
|
|
763
736
|
## Call Signature
|
|
764
737
|
|
|
765
738
|
```ts
|
|
766
|
-
function isEmptyObject(value): value is {};
|
|
739
|
+
function isEmptyObject(value: unknown): value is {};
|
|
767
740
|
```
|
|
768
741
|
|
|
769
742
|
Type guard that checks whether a value is an object with no own keys.
|
|
770
743
|
|
|
771
744
|
### Parameters
|
|
772
745
|
|
|
773
|
-
|
|
774
|
-
|
|
775
|
-
`unknown`
|
|
746
|
+
| Parameter | Type |
|
|
747
|
+
| ------ | ------ |
|
|
748
|
+
| `value` | `unknown` |
|
|
776
749
|
|
|
777
750
|
### Returns
|
|
778
751
|
|
|
@@ -781,30 +754,24 @@ Type guard that checks whether a value is an object with no own keys.
|
|
|
781
754
|
## Call Signature
|
|
782
755
|
|
|
783
756
|
```ts
|
|
784
|
-
function isEmptyObject<K, V, T>(value): value is Extract<T, Record<K, never>>;
|
|
757
|
+
function isEmptyObject<K, V, T>(value: T): value is Extract<T, Record<K, never>>;
|
|
785
758
|
```
|
|
786
759
|
|
|
787
760
|
Type guard that checks whether a value is an object with no own keys.
|
|
788
761
|
|
|
789
762
|
### Type Parameters
|
|
790
763
|
|
|
791
|
-
|
|
792
|
-
|
|
793
|
-
`K` *extends* [`RecordKey`](#../type-aliases/RecordKey)
|
|
794
|
-
|
|
795
|
-
|
|
796
|
-
|
|
797
|
-
`V`
|
|
798
|
-
|
|
799
|
-
### T
|
|
800
|
-
|
|
801
|
-
`T` *extends* `Record`\<`K`, `V`\>
|
|
764
|
+
| Type Parameter |
|
|
765
|
+
| ------ |
|
|
766
|
+
| `K` *extends* [`RecordKey`](#../type-aliases/RecordKey) |
|
|
767
|
+
| `V` |
|
|
768
|
+
| `T` *extends* `Record`\<`K`, `V`\> |
|
|
802
769
|
|
|
803
770
|
### Parameters
|
|
804
771
|
|
|
805
|
-
|
|
806
|
-
|
|
807
|
-
`T`
|
|
772
|
+
| Parameter | Type |
|
|
773
|
+
| ------ | ------ |
|
|
774
|
+
| `value` | `T` |
|
|
808
775
|
|
|
809
776
|
### Returns
|
|
810
777
|
|
|
@@ -819,16 +786,16 @@ Type guard that checks whether a value is an object with no own keys.
|
|
|
819
786
|
## Call Signature
|
|
820
787
|
|
|
821
788
|
```ts
|
|
822
|
-
function isEmptyString(value): value is "";
|
|
789
|
+
function isEmptyString(value: unknown): value is "";
|
|
823
790
|
```
|
|
824
791
|
|
|
825
792
|
Type guard that checks whether a value is an empty string.
|
|
826
793
|
|
|
827
794
|
### Parameters
|
|
828
795
|
|
|
829
|
-
|
|
830
|
-
|
|
831
|
-
`unknown`
|
|
796
|
+
| Parameter | Type |
|
|
797
|
+
| ------ | ------ |
|
|
798
|
+
| `value` | `unknown` |
|
|
832
799
|
|
|
833
800
|
### Returns
|
|
834
801
|
|
|
@@ -837,22 +804,22 @@ Type guard that checks whether a value is an empty string.
|
|
|
837
804
|
## Call Signature
|
|
838
805
|
|
|
839
806
|
```ts
|
|
840
|
-
function isEmptyString<T>(value): value is Extract<T, "">;
|
|
807
|
+
function isEmptyString<T>(value: T): value is Extract<T, "">;
|
|
841
808
|
```
|
|
842
809
|
|
|
843
810
|
Type guard that checks whether a value is an empty string.
|
|
844
811
|
|
|
845
812
|
### Type Parameters
|
|
846
813
|
|
|
847
|
-
|
|
848
|
-
|
|
849
|
-
`T` *extends* `string`
|
|
814
|
+
| Type Parameter |
|
|
815
|
+
| ------ |
|
|
816
|
+
| `T` *extends* `string` |
|
|
850
817
|
|
|
851
818
|
### Parameters
|
|
852
819
|
|
|
853
|
-
|
|
854
|
-
|
|
855
|
-
`T`
|
|
820
|
+
| Parameter | Type |
|
|
821
|
+
| ------ | ------ |
|
|
822
|
+
| `value` | `T` |
|
|
856
823
|
|
|
857
824
|
### Returns
|
|
858
825
|
|
|
@@ -867,16 +834,16 @@ Type guard that checks whether a value is an empty string.
|
|
|
867
834
|
## Call Signature
|
|
868
835
|
|
|
869
836
|
```ts
|
|
870
|
-
function isError(value): value is Error;
|
|
837
|
+
function isError(value: unknown): value is Error;
|
|
871
838
|
```
|
|
872
839
|
|
|
873
840
|
Type guard that checks whether a value is an Error instance.
|
|
874
841
|
|
|
875
842
|
### Parameters
|
|
876
843
|
|
|
877
|
-
|
|
878
|
-
|
|
879
|
-
`unknown`
|
|
844
|
+
| Parameter | Type |
|
|
845
|
+
| ------ | ------ |
|
|
846
|
+
| `value` | `unknown` |
|
|
880
847
|
|
|
881
848
|
### Returns
|
|
882
849
|
|
|
@@ -885,22 +852,22 @@ Type guard that checks whether a value is an Error instance.
|
|
|
885
852
|
## Call Signature
|
|
886
853
|
|
|
887
854
|
```ts
|
|
888
|
-
function isError<T>(value): value is Extract<T, Error>;
|
|
855
|
+
function isError<T>(value: T): value is Extract<T, Error>;
|
|
889
856
|
```
|
|
890
857
|
|
|
891
858
|
Type guard that checks whether a value is an Error instance.
|
|
892
859
|
|
|
893
860
|
### Type Parameters
|
|
894
861
|
|
|
895
|
-
|
|
896
|
-
|
|
897
|
-
`T`
|
|
862
|
+
| Type Parameter |
|
|
863
|
+
| ------ |
|
|
864
|
+
| `T` |
|
|
898
865
|
|
|
899
866
|
### Parameters
|
|
900
867
|
|
|
901
|
-
|
|
902
|
-
|
|
903
|
-
`T`
|
|
868
|
+
| Parameter | Type |
|
|
869
|
+
| ------ | ------ |
|
|
870
|
+
| `value` | `T` |
|
|
904
871
|
|
|
905
872
|
### Returns
|
|
906
873
|
|
|
@@ -915,22 +882,22 @@ Type guard that checks whether a value is an Error instance.
|
|
|
915
882
|
## Call Signature
|
|
916
883
|
|
|
917
884
|
```ts
|
|
918
|
-
function isFalsy<T>(value): value is Extract<T, false | "" | 0 | 0n | null | undefined>;
|
|
885
|
+
function isFalsy<T>(value: T): value is Extract<T, false | "" | 0 | 0n | null | undefined>;
|
|
919
886
|
```
|
|
920
887
|
|
|
921
888
|
Type guard that checks whether a value is falsy (0, null, undefined, false, '', or 0n).
|
|
922
889
|
|
|
923
890
|
### Type Parameters
|
|
924
891
|
|
|
925
|
-
|
|
926
|
-
|
|
927
|
-
`T`
|
|
892
|
+
| Type Parameter |
|
|
893
|
+
| ------ |
|
|
894
|
+
| `T` |
|
|
928
895
|
|
|
929
896
|
### Parameters
|
|
930
897
|
|
|
931
|
-
|
|
932
|
-
|
|
933
|
-
`T`
|
|
898
|
+
| Parameter | Type |
|
|
899
|
+
| ------ | ------ |
|
|
900
|
+
| `value` | `T` |
|
|
934
901
|
|
|
935
902
|
### Returns
|
|
936
903
|
|
|
@@ -939,22 +906,22 @@ value is Extract\<T, false \| "" \| 0 \| 0n \| null \| undefined\>
|
|
|
939
906
|
## Call Signature
|
|
940
907
|
|
|
941
908
|
```ts
|
|
942
|
-
function isFalsy<T>(value): value is Extract<T, false>;
|
|
909
|
+
function isFalsy<T>(value: T): value is Extract<T, false>;
|
|
943
910
|
```
|
|
944
911
|
|
|
945
912
|
Type guard that checks whether a value is falsy (0, null, undefined, false, '', or 0n).
|
|
946
913
|
|
|
947
914
|
### Type Parameters
|
|
948
915
|
|
|
949
|
-
|
|
950
|
-
|
|
951
|
-
`T` *extends* `boolean`
|
|
916
|
+
| Type Parameter |
|
|
917
|
+
| ------ |
|
|
918
|
+
| `T` *extends* `boolean` |
|
|
952
919
|
|
|
953
920
|
### Parameters
|
|
954
921
|
|
|
955
|
-
|
|
956
|
-
|
|
957
|
-
`T`
|
|
922
|
+
| Parameter | Type |
|
|
923
|
+
| ------ | ------ |
|
|
924
|
+
| `value` | `T` |
|
|
958
925
|
|
|
959
926
|
### Returns
|
|
960
927
|
|
|
@@ -963,22 +930,22 @@ Type guard that checks whether a value is falsy (0, null, undefined, false, '',
|
|
|
963
930
|
## Call Signature
|
|
964
931
|
|
|
965
932
|
```ts
|
|
966
|
-
function isFalsy<T>(value): value is Extract<T, 0>;
|
|
933
|
+
function isFalsy<T>(value: T): value is Extract<T, 0>;
|
|
967
934
|
```
|
|
968
935
|
|
|
969
936
|
Type guard that checks whether a value is falsy (0, null, undefined, false, '', or 0n).
|
|
970
937
|
|
|
971
938
|
### Type Parameters
|
|
972
939
|
|
|
973
|
-
|
|
974
|
-
|
|
975
|
-
`T` *extends* `number`
|
|
940
|
+
| Type Parameter |
|
|
941
|
+
| ------ |
|
|
942
|
+
| `T` *extends* `number` |
|
|
976
943
|
|
|
977
944
|
### Parameters
|
|
978
945
|
|
|
979
|
-
|
|
980
|
-
|
|
981
|
-
`T`
|
|
946
|
+
| Parameter | Type |
|
|
947
|
+
| ------ | ------ |
|
|
948
|
+
| `value` | `T` |
|
|
982
949
|
|
|
983
950
|
### Returns
|
|
984
951
|
|
|
@@ -987,22 +954,22 @@ Type guard that checks whether a value is falsy (0, null, undefined, false, '',
|
|
|
987
954
|
## Call Signature
|
|
988
955
|
|
|
989
956
|
```ts
|
|
990
|
-
function isFalsy<T>(value): value is Extract<T, 0n>;
|
|
957
|
+
function isFalsy<T>(value: T): value is Extract<T, 0n>;
|
|
991
958
|
```
|
|
992
959
|
|
|
993
960
|
Type guard that checks whether a value is falsy (0, null, undefined, false, '', or 0n).
|
|
994
961
|
|
|
995
962
|
### Type Parameters
|
|
996
963
|
|
|
997
|
-
|
|
998
|
-
|
|
999
|
-
`T` *extends* `bigint`
|
|
964
|
+
| Type Parameter |
|
|
965
|
+
| ------ |
|
|
966
|
+
| `T` *extends* `bigint` |
|
|
1000
967
|
|
|
1001
968
|
### Parameters
|
|
1002
969
|
|
|
1003
|
-
|
|
1004
|
-
|
|
1005
|
-
`T`
|
|
970
|
+
| Parameter | Type |
|
|
971
|
+
| ------ | ------ |
|
|
972
|
+
| `value` | `T` |
|
|
1006
973
|
|
|
1007
974
|
### Returns
|
|
1008
975
|
|
|
@@ -1011,22 +978,22 @@ Type guard that checks whether a value is falsy (0, null, undefined, false, '',
|
|
|
1011
978
|
## Call Signature
|
|
1012
979
|
|
|
1013
980
|
```ts
|
|
1014
|
-
function isFalsy<T>(value): value is Extract<T, null>;
|
|
981
|
+
function isFalsy<T>(value: T): value is Extract<T, null>;
|
|
1015
982
|
```
|
|
1016
983
|
|
|
1017
984
|
Type guard that checks whether a value is falsy (0, null, undefined, false, '', or 0n).
|
|
1018
985
|
|
|
1019
986
|
### Type Parameters
|
|
1020
987
|
|
|
1021
|
-
|
|
1022
|
-
|
|
1023
|
-
`T` *extends* `null`
|
|
988
|
+
| Type Parameter |
|
|
989
|
+
| ------ |
|
|
990
|
+
| `T` *extends* `null` |
|
|
1024
991
|
|
|
1025
992
|
### Parameters
|
|
1026
993
|
|
|
1027
|
-
|
|
1028
|
-
|
|
1029
|
-
`T`
|
|
994
|
+
| Parameter | Type |
|
|
995
|
+
| ------ | ------ |
|
|
996
|
+
| `value` | `T` |
|
|
1030
997
|
|
|
1031
998
|
### Returns
|
|
1032
999
|
|
|
@@ -1035,22 +1002,22 @@ Type guard that checks whether a value is falsy (0, null, undefined, false, '',
|
|
|
1035
1002
|
## Call Signature
|
|
1036
1003
|
|
|
1037
1004
|
```ts
|
|
1038
|
-
function isFalsy<T>(value): value is Extract<T, undefined>;
|
|
1005
|
+
function isFalsy<T>(value: T): value is Extract<T, undefined>;
|
|
1039
1006
|
```
|
|
1040
1007
|
|
|
1041
1008
|
Type guard that checks whether a value is falsy (0, null, undefined, false, '', or 0n).
|
|
1042
1009
|
|
|
1043
1010
|
### Type Parameters
|
|
1044
1011
|
|
|
1045
|
-
|
|
1046
|
-
|
|
1047
|
-
`T` *extends* `undefined`
|
|
1012
|
+
| Type Parameter |
|
|
1013
|
+
| ------ |
|
|
1014
|
+
| `T` *extends* `undefined` |
|
|
1048
1015
|
|
|
1049
1016
|
### Parameters
|
|
1050
1017
|
|
|
1051
|
-
|
|
1052
|
-
|
|
1053
|
-
`T`
|
|
1018
|
+
| Parameter | Type |
|
|
1019
|
+
| ------ | ------ |
|
|
1020
|
+
| `value` | `T` |
|
|
1054
1021
|
|
|
1055
1022
|
### Returns
|
|
1056
1023
|
|
|
@@ -1059,22 +1026,22 @@ Type guard that checks whether a value is falsy (0, null, undefined, false, '',
|
|
|
1059
1026
|
## Call Signature
|
|
1060
1027
|
|
|
1061
1028
|
```ts
|
|
1062
|
-
function isFalsy<T>(value): value is Extract<T, "">;
|
|
1029
|
+
function isFalsy<T>(value: T): value is Extract<T, "">;
|
|
1063
1030
|
```
|
|
1064
1031
|
|
|
1065
1032
|
Type guard that checks whether a value is falsy (0, null, undefined, false, '', or 0n).
|
|
1066
1033
|
|
|
1067
1034
|
### Type Parameters
|
|
1068
1035
|
|
|
1069
|
-
|
|
1070
|
-
|
|
1071
|
-
`T` *extends* `string`
|
|
1036
|
+
| Type Parameter |
|
|
1037
|
+
| ------ |
|
|
1038
|
+
| `T` *extends* `string` |
|
|
1072
1039
|
|
|
1073
1040
|
### Parameters
|
|
1074
1041
|
|
|
1075
|
-
|
|
1076
|
-
|
|
1077
|
-
`T`
|
|
1042
|
+
| Parameter | Type |
|
|
1043
|
+
| ------ | ------ |
|
|
1044
|
+
| `value` | `T` |
|
|
1078
1045
|
|
|
1079
1046
|
### Returns
|
|
1080
1047
|
|
|
@@ -1089,16 +1056,16 @@ Type guard that checks whether a value is falsy (0, null, undefined, false, '',
|
|
|
1089
1056
|
## Call Signature
|
|
1090
1057
|
|
|
1091
1058
|
```ts
|
|
1092
|
-
function isFile(value): value is File;
|
|
1059
|
+
function isFile(value: unknown): value is File;
|
|
1093
1060
|
```
|
|
1094
1061
|
|
|
1095
1062
|
Type guard that checks whether a value is a File instance.
|
|
1096
1063
|
|
|
1097
1064
|
### Parameters
|
|
1098
1065
|
|
|
1099
|
-
|
|
1100
|
-
|
|
1101
|
-
`unknown`
|
|
1066
|
+
| Parameter | Type |
|
|
1067
|
+
| ------ | ------ |
|
|
1068
|
+
| `value` | `unknown` |
|
|
1102
1069
|
|
|
1103
1070
|
### Returns
|
|
1104
1071
|
|
|
@@ -1107,22 +1074,22 @@ Type guard that checks whether a value is a File instance.
|
|
|
1107
1074
|
## Call Signature
|
|
1108
1075
|
|
|
1109
1076
|
```ts
|
|
1110
|
-
function isFile<T>(value): value is Extract<T, File>;
|
|
1077
|
+
function isFile<T>(value: T): value is Extract<T, File>;
|
|
1111
1078
|
```
|
|
1112
1079
|
|
|
1113
1080
|
Type guard that checks whether a value is a File instance.
|
|
1114
1081
|
|
|
1115
1082
|
### Type Parameters
|
|
1116
1083
|
|
|
1117
|
-
|
|
1118
|
-
|
|
1119
|
-
`T` *extends* `File`
|
|
1084
|
+
| Type Parameter |
|
|
1085
|
+
| ------ |
|
|
1086
|
+
| `T` *extends* `File` |
|
|
1120
1087
|
|
|
1121
1088
|
### Parameters
|
|
1122
1089
|
|
|
1123
|
-
|
|
1124
|
-
|
|
1125
|
-
`T`
|
|
1090
|
+
| Parameter | Type |
|
|
1091
|
+
| ------ | ------ |
|
|
1092
|
+
| `value` | `T` |
|
|
1126
1093
|
|
|
1127
1094
|
### Returns
|
|
1128
1095
|
|
|
@@ -1137,16 +1104,16 @@ Type guard that checks whether a value is a File instance.
|
|
|
1137
1104
|
## Call Signature
|
|
1138
1105
|
|
|
1139
1106
|
```ts
|
|
1140
|
-
function isFunction(value): value is AnyFunction;
|
|
1107
|
+
function isFunction(value: unknown): value is AnyFunction;
|
|
1141
1108
|
```
|
|
1142
1109
|
|
|
1143
1110
|
Type guard that checks whether a value is a function.
|
|
1144
1111
|
|
|
1145
1112
|
### Parameters
|
|
1146
1113
|
|
|
1147
|
-
|
|
1148
|
-
|
|
1149
|
-
`unknown`
|
|
1114
|
+
| Parameter | Type |
|
|
1115
|
+
| ------ | ------ |
|
|
1116
|
+
| `value` | `unknown` |
|
|
1150
1117
|
|
|
1151
1118
|
### Returns
|
|
1152
1119
|
|
|
@@ -1155,22 +1122,22 @@ Type guard that checks whether a value is a function.
|
|
|
1155
1122
|
## Call Signature
|
|
1156
1123
|
|
|
1157
1124
|
```ts
|
|
1158
|
-
function isFunction<T>(value): value is Extract<T, AnyFunction>;
|
|
1125
|
+
function isFunction<T>(value: T): value is Extract<T, AnyFunction>;
|
|
1159
1126
|
```
|
|
1160
1127
|
|
|
1161
1128
|
Type guard that checks whether a value is a function.
|
|
1162
1129
|
|
|
1163
1130
|
### Type Parameters
|
|
1164
1131
|
|
|
1165
|
-
|
|
1166
|
-
|
|
1167
|
-
`T` *extends* [`AnyFunction`](#../type-aliases/AnyFunction)
|
|
1132
|
+
| Type Parameter |
|
|
1133
|
+
| ------ |
|
|
1134
|
+
| `T` *extends* [`AnyFunction`](#../type-aliases/AnyFunction) |
|
|
1168
1135
|
|
|
1169
1136
|
### Parameters
|
|
1170
1137
|
|
|
1171
|
-
|
|
1172
|
-
|
|
1173
|
-
`T`
|
|
1138
|
+
| Parameter | Type |
|
|
1139
|
+
| ------ | ------ |
|
|
1140
|
+
| `value` | `T` |
|
|
1174
1141
|
|
|
1175
1142
|
### Returns
|
|
1176
1143
|
|
|
@@ -1185,16 +1152,16 @@ Type guard that checks whether a value is a function.
|
|
|
1185
1152
|
## Call Signature
|
|
1186
1153
|
|
|
1187
1154
|
```ts
|
|
1188
|
-
function isMap(value): value is Map<unknown, unknown>;
|
|
1155
|
+
function isMap(value: unknown): value is Map<unknown, unknown>;
|
|
1189
1156
|
```
|
|
1190
1157
|
|
|
1191
1158
|
Type guard that checks whether a value is a Map instance.
|
|
1192
1159
|
|
|
1193
1160
|
### Parameters
|
|
1194
1161
|
|
|
1195
|
-
|
|
1196
|
-
|
|
1197
|
-
`unknown`
|
|
1162
|
+
| Parameter | Type |
|
|
1163
|
+
| ------ | ------ |
|
|
1164
|
+
| `value` | `unknown` |
|
|
1198
1165
|
|
|
1199
1166
|
### Returns
|
|
1200
1167
|
|
|
@@ -1203,30 +1170,24 @@ Type guard that checks whether a value is a Map instance.
|
|
|
1203
1170
|
## Call Signature
|
|
1204
1171
|
|
|
1205
1172
|
```ts
|
|
1206
|
-
function isMap<K, V, T>(value): value is Extract<T, Map<K, V>>;
|
|
1173
|
+
function isMap<K, V, T>(value: T): value is Extract<T, Map<K, V>>;
|
|
1207
1174
|
```
|
|
1208
1175
|
|
|
1209
1176
|
Type guard that checks whether a value is a Map instance.
|
|
1210
1177
|
|
|
1211
1178
|
### Type Parameters
|
|
1212
1179
|
|
|
1213
|
-
|
|
1214
|
-
|
|
1215
|
-
`K`
|
|
1216
|
-
|
|
1217
|
-
|
|
1218
|
-
|
|
1219
|
-
`V`
|
|
1220
|
-
|
|
1221
|
-
### T
|
|
1222
|
-
|
|
1223
|
-
`T` *extends* `Map`\<`K`, `V`\>
|
|
1180
|
+
| Type Parameter |
|
|
1181
|
+
| ------ |
|
|
1182
|
+
| `K` |
|
|
1183
|
+
| `V` |
|
|
1184
|
+
| `T` *extends* `Map`\<`K`, `V`\> |
|
|
1224
1185
|
|
|
1225
1186
|
### Parameters
|
|
1226
1187
|
|
|
1227
|
-
|
|
1228
|
-
|
|
1229
|
-
`T`
|
|
1188
|
+
| Parameter | Type |
|
|
1189
|
+
| ------ | ------ |
|
|
1190
|
+
| `value` | `T` |
|
|
1230
1191
|
|
|
1231
1192
|
### Returns
|
|
1232
1193
|
|
|
@@ -1241,16 +1202,16 @@ Type guard that checks whether a value is a Map instance.
|
|
|
1241
1202
|
## Call Signature
|
|
1242
1203
|
|
|
1243
1204
|
```ts
|
|
1244
|
-
function isNull(value): value is null;
|
|
1205
|
+
function isNull(value: unknown): value is null;
|
|
1245
1206
|
```
|
|
1246
1207
|
|
|
1247
1208
|
Type guard that checks whether a value is null.
|
|
1248
1209
|
|
|
1249
1210
|
### Parameters
|
|
1250
1211
|
|
|
1251
|
-
|
|
1252
|
-
|
|
1253
|
-
`unknown`
|
|
1212
|
+
| Parameter | Type |
|
|
1213
|
+
| ------ | ------ |
|
|
1214
|
+
| `value` | `unknown` |
|
|
1254
1215
|
|
|
1255
1216
|
### Returns
|
|
1256
1217
|
|
|
@@ -1259,22 +1220,22 @@ Type guard that checks whether a value is null.
|
|
|
1259
1220
|
## Call Signature
|
|
1260
1221
|
|
|
1261
1222
|
```ts
|
|
1262
|
-
function isNull<T>(value): value is Extract<T, null>;
|
|
1223
|
+
function isNull<T>(value: T): value is Extract<T, null>;
|
|
1263
1224
|
```
|
|
1264
1225
|
|
|
1265
1226
|
Type guard that checks whether a value is null.
|
|
1266
1227
|
|
|
1267
1228
|
### Type Parameters
|
|
1268
1229
|
|
|
1269
|
-
|
|
1270
|
-
|
|
1271
|
-
`T`
|
|
1230
|
+
| Type Parameter |
|
|
1231
|
+
| ------ |
|
|
1232
|
+
| `T` |
|
|
1272
1233
|
|
|
1273
1234
|
### Parameters
|
|
1274
1235
|
|
|
1275
|
-
|
|
1276
|
-
|
|
1277
|
-
`T`
|
|
1236
|
+
| Parameter | Type |
|
|
1237
|
+
| ------ | ------ |
|
|
1238
|
+
| `value` | `T` |
|
|
1278
1239
|
|
|
1279
1240
|
### Returns
|
|
1280
1241
|
|
|
@@ -1289,16 +1250,16 @@ Type guard that checks whether a value is null.
|
|
|
1289
1250
|
## Call Signature
|
|
1290
1251
|
|
|
1291
1252
|
```ts
|
|
1292
|
-
function isNumber(value): value is number;
|
|
1253
|
+
function isNumber(value: unknown): value is number;
|
|
1293
1254
|
```
|
|
1294
1255
|
|
|
1295
1256
|
Type guard that checks whether a value is a number.
|
|
1296
1257
|
|
|
1297
1258
|
### Parameters
|
|
1298
1259
|
|
|
1299
|
-
|
|
1300
|
-
|
|
1301
|
-
`unknown`
|
|
1260
|
+
| Parameter | Type |
|
|
1261
|
+
| ------ | ------ |
|
|
1262
|
+
| `value` | `unknown` |
|
|
1302
1263
|
|
|
1303
1264
|
### Returns
|
|
1304
1265
|
|
|
@@ -1307,22 +1268,22 @@ Type guard that checks whether a value is a number.
|
|
|
1307
1268
|
## Call Signature
|
|
1308
1269
|
|
|
1309
1270
|
```ts
|
|
1310
|
-
function isNumber<T>(value): value is Extract<T, number>;
|
|
1271
|
+
function isNumber<T>(value: T): value is Extract<T, number>;
|
|
1311
1272
|
```
|
|
1312
1273
|
|
|
1313
1274
|
Type guard that checks whether a value is a number.
|
|
1314
1275
|
|
|
1315
1276
|
### Type Parameters
|
|
1316
1277
|
|
|
1317
|
-
|
|
1318
|
-
|
|
1319
|
-
`T` *extends* `number`
|
|
1278
|
+
| Type Parameter |
|
|
1279
|
+
| ------ |
|
|
1280
|
+
| `T` *extends* `number` |
|
|
1320
1281
|
|
|
1321
1282
|
### Parameters
|
|
1322
1283
|
|
|
1323
|
-
|
|
1324
|
-
|
|
1325
|
-
`T`
|
|
1284
|
+
| Parameter | Type |
|
|
1285
|
+
| ------ | ------ |
|
|
1286
|
+
| `value` | `T` |
|
|
1326
1287
|
|
|
1327
1288
|
### Returns
|
|
1328
1289
|
|
|
@@ -1337,16 +1298,16 @@ Type guard that checks whether a value is a number.
|
|
|
1337
1298
|
## Call Signature
|
|
1338
1299
|
|
|
1339
1300
|
```ts
|
|
1340
|
-
function isObject(value): value is object;
|
|
1301
|
+
function isObject(value: unknown): value is object;
|
|
1341
1302
|
```
|
|
1342
1303
|
|
|
1343
1304
|
Type guard that checks whether a value is a plain object (not null and not an array).
|
|
1344
1305
|
|
|
1345
1306
|
### Parameters
|
|
1346
1307
|
|
|
1347
|
-
|
|
1348
|
-
|
|
1349
|
-
`unknown`
|
|
1308
|
+
| Parameter | Type |
|
|
1309
|
+
| ------ | ------ |
|
|
1310
|
+
| `value` | `unknown` |
|
|
1350
1311
|
|
|
1351
1312
|
### Returns
|
|
1352
1313
|
|
|
@@ -1355,22 +1316,22 @@ Type guard that checks whether a value is a plain object (not null and not an ar
|
|
|
1355
1316
|
## Call Signature
|
|
1356
1317
|
|
|
1357
1318
|
```ts
|
|
1358
|
-
function isObject<T>(value): value is Extract<T, object>;
|
|
1319
|
+
function isObject<T>(value: T): value is Extract<T, object>;
|
|
1359
1320
|
```
|
|
1360
1321
|
|
|
1361
1322
|
Type guard that checks whether a value is a plain object (not null and not an array).
|
|
1362
1323
|
|
|
1363
1324
|
### Type Parameters
|
|
1364
1325
|
|
|
1365
|
-
|
|
1366
|
-
|
|
1367
|
-
`T` *extends* `object`
|
|
1326
|
+
| Type Parameter |
|
|
1327
|
+
| ------ |
|
|
1328
|
+
| `T` *extends* `object` |
|
|
1368
1329
|
|
|
1369
1330
|
### Parameters
|
|
1370
1331
|
|
|
1371
|
-
|
|
1372
|
-
|
|
1373
|
-
`T`
|
|
1332
|
+
| Parameter | Type |
|
|
1333
|
+
| ------ | ------ |
|
|
1334
|
+
| `value` | `T` |
|
|
1374
1335
|
|
|
1375
1336
|
### Returns
|
|
1376
1337
|
|
|
@@ -1385,16 +1346,16 @@ Type guard that checks whether a value is a plain object (not null and not an ar
|
|
|
1385
1346
|
## Call Signature
|
|
1386
1347
|
|
|
1387
1348
|
```ts
|
|
1388
|
-
function isPopulatedArray(value): value is readonly unknown[];
|
|
1349
|
+
function isPopulatedArray(value: unknown): value is readonly unknown[];
|
|
1389
1350
|
```
|
|
1390
1351
|
|
|
1391
1352
|
Type guard that checks whether a value is a non-empty array.
|
|
1392
1353
|
|
|
1393
1354
|
### Parameters
|
|
1394
1355
|
|
|
1395
|
-
|
|
1396
|
-
|
|
1397
|
-
`unknown`
|
|
1356
|
+
| Parameter | Type |
|
|
1357
|
+
| ------ | ------ |
|
|
1358
|
+
| `value` | `unknown` |
|
|
1398
1359
|
|
|
1399
1360
|
### Returns
|
|
1400
1361
|
|
|
@@ -1403,22 +1364,22 @@ Type guard that checks whether a value is a non-empty array.
|
|
|
1403
1364
|
## Call Signature
|
|
1404
1365
|
|
|
1405
1366
|
```ts
|
|
1406
|
-
function isPopulatedArray<T>(value): value is Extract<T, readonly unknown[]>;
|
|
1367
|
+
function isPopulatedArray<T>(value: T): value is Extract<T, readonly unknown[]>;
|
|
1407
1368
|
```
|
|
1408
1369
|
|
|
1409
1370
|
Type guard that checks whether a value is a non-empty array.
|
|
1410
1371
|
|
|
1411
1372
|
### Type Parameters
|
|
1412
1373
|
|
|
1413
|
-
|
|
1414
|
-
|
|
1415
|
-
`T` *extends* `unknown`[]
|
|
1374
|
+
| Type Parameter |
|
|
1375
|
+
| ------ |
|
|
1376
|
+
| `T` *extends* `unknown`[] |
|
|
1416
1377
|
|
|
1417
1378
|
### Parameters
|
|
1418
1379
|
|
|
1419
|
-
|
|
1420
|
-
|
|
1421
|
-
`T`
|
|
1380
|
+
| Parameter | Type |
|
|
1381
|
+
| ------ | ------ |
|
|
1382
|
+
| `value` | `T` |
|
|
1422
1383
|
|
|
1423
1384
|
### Returns
|
|
1424
1385
|
|
|
@@ -1433,16 +1394,16 @@ Type guard that checks whether a value is a non-empty array.
|
|
|
1433
1394
|
## Call Signature
|
|
1434
1395
|
|
|
1435
1396
|
```ts
|
|
1436
|
-
function isPromise(value): value is Promise<unknown>;
|
|
1397
|
+
function isPromise(value: unknown): value is Promise<unknown>;
|
|
1437
1398
|
```
|
|
1438
1399
|
|
|
1439
1400
|
Type guard that checks whether a value is a Promise instance.
|
|
1440
1401
|
|
|
1441
1402
|
### Parameters
|
|
1442
1403
|
|
|
1443
|
-
|
|
1444
|
-
|
|
1445
|
-
`unknown`
|
|
1404
|
+
| Parameter | Type |
|
|
1405
|
+
| ------ | ------ |
|
|
1406
|
+
| `value` | `unknown` |
|
|
1446
1407
|
|
|
1447
1408
|
### Returns
|
|
1448
1409
|
|
|
@@ -1451,22 +1412,22 @@ Type guard that checks whether a value is a Promise instance.
|
|
|
1451
1412
|
## Call Signature
|
|
1452
1413
|
|
|
1453
1414
|
```ts
|
|
1454
|
-
function isPromise<T>(value): value is Extract<T, Promise<unknown>>;
|
|
1415
|
+
function isPromise<T>(value: T): value is Extract<T, Promise<unknown>>;
|
|
1455
1416
|
```
|
|
1456
1417
|
|
|
1457
1418
|
Type guard that checks whether a value is a Promise instance.
|
|
1458
1419
|
|
|
1459
1420
|
### Type Parameters
|
|
1460
1421
|
|
|
1461
|
-
|
|
1462
|
-
|
|
1463
|
-
`T`
|
|
1422
|
+
| Type Parameter |
|
|
1423
|
+
| ------ |
|
|
1424
|
+
| `T` |
|
|
1464
1425
|
|
|
1465
1426
|
### Parameters
|
|
1466
1427
|
|
|
1467
|
-
|
|
1468
|
-
|
|
1469
|
-
`T`
|
|
1428
|
+
| Parameter | Type |
|
|
1429
|
+
| ------ | ------ |
|
|
1430
|
+
| `value` | `T` |
|
|
1470
1431
|
|
|
1471
1432
|
### Returns
|
|
1472
1433
|
|
|
@@ -1481,16 +1442,16 @@ Type guard that checks whether a value is a Promise instance.
|
|
|
1481
1442
|
## Call Signature
|
|
1482
1443
|
|
|
1483
1444
|
```ts
|
|
1484
|
-
function isPromiseLike(value): value is Promise<unknown>;
|
|
1445
|
+
function isPromiseLike(value: unknown): value is Promise<unknown>;
|
|
1485
1446
|
```
|
|
1486
1447
|
|
|
1487
1448
|
Type guard that checks whether a value is promise-like (has a `then` method).
|
|
1488
1449
|
|
|
1489
1450
|
### Parameters
|
|
1490
1451
|
|
|
1491
|
-
|
|
1492
|
-
|
|
1493
|
-
`unknown`
|
|
1452
|
+
| Parameter | Type |
|
|
1453
|
+
| ------ | ------ |
|
|
1454
|
+
| `value` | `unknown` |
|
|
1494
1455
|
|
|
1495
1456
|
### Returns
|
|
1496
1457
|
|
|
@@ -1499,22 +1460,22 @@ Type guard that checks whether a value is promise-like (has a `then` method).
|
|
|
1499
1460
|
## Call Signature
|
|
1500
1461
|
|
|
1501
1462
|
```ts
|
|
1502
|
-
function isPromiseLike<T>(value): value is Extract<T, Promise<unknown>>;
|
|
1463
|
+
function isPromiseLike<T>(value: T): value is Extract<T, Promise<unknown>>;
|
|
1503
1464
|
```
|
|
1504
1465
|
|
|
1505
1466
|
Type guard that checks whether a value is promise-like (has a `then` method).
|
|
1506
1467
|
|
|
1507
1468
|
### Type Parameters
|
|
1508
1469
|
|
|
1509
|
-
|
|
1510
|
-
|
|
1511
|
-
`T`
|
|
1470
|
+
| Type Parameter |
|
|
1471
|
+
| ------ |
|
|
1472
|
+
| `T` |
|
|
1512
1473
|
|
|
1513
1474
|
### Parameters
|
|
1514
1475
|
|
|
1515
|
-
|
|
1516
|
-
|
|
1517
|
-
`T`
|
|
1476
|
+
| Parameter | Type |
|
|
1477
|
+
| ------ | ------ |
|
|
1478
|
+
| `value` | `T` |
|
|
1518
1479
|
|
|
1519
1480
|
### Returns
|
|
1520
1481
|
|
|
@@ -1529,16 +1490,16 @@ Type guard that checks whether a value is promise-like (has a `then` method).
|
|
|
1529
1490
|
## Call Signature
|
|
1530
1491
|
|
|
1531
1492
|
```ts
|
|
1532
|
-
function isRegExp(value): value is RegExp;
|
|
1493
|
+
function isRegExp(value: unknown): value is RegExp;
|
|
1533
1494
|
```
|
|
1534
1495
|
|
|
1535
1496
|
Type guard that checks whether a value is a RegExp instance.
|
|
1536
1497
|
|
|
1537
1498
|
### Parameters
|
|
1538
1499
|
|
|
1539
|
-
|
|
1540
|
-
|
|
1541
|
-
`unknown`
|
|
1500
|
+
| Parameter | Type |
|
|
1501
|
+
| ------ | ------ |
|
|
1502
|
+
| `value` | `unknown` |
|
|
1542
1503
|
|
|
1543
1504
|
### Returns
|
|
1544
1505
|
|
|
@@ -1547,22 +1508,22 @@ Type guard that checks whether a value is a RegExp instance.
|
|
|
1547
1508
|
## Call Signature
|
|
1548
1509
|
|
|
1549
1510
|
```ts
|
|
1550
|
-
function isRegExp<T>(value): value is Extract<T, RegExp>;
|
|
1511
|
+
function isRegExp<T>(value: T): value is Extract<T, RegExp>;
|
|
1551
1512
|
```
|
|
1552
1513
|
|
|
1553
1514
|
Type guard that checks whether a value is a RegExp instance.
|
|
1554
1515
|
|
|
1555
1516
|
### Type Parameters
|
|
1556
1517
|
|
|
1557
|
-
|
|
1558
|
-
|
|
1559
|
-
`T` *extends* `RegExp`
|
|
1518
|
+
| Type Parameter |
|
|
1519
|
+
| ------ |
|
|
1520
|
+
| `T` *extends* `RegExp` |
|
|
1560
1521
|
|
|
1561
1522
|
### Parameters
|
|
1562
1523
|
|
|
1563
|
-
|
|
1564
|
-
|
|
1565
|
-
`T`
|
|
1524
|
+
| Parameter | Type |
|
|
1525
|
+
| ------ | ------ |
|
|
1526
|
+
| `value` | `T` |
|
|
1566
1527
|
|
|
1567
1528
|
### Returns
|
|
1568
1529
|
|
|
@@ -1577,16 +1538,16 @@ Type guard that checks whether a value is a RegExp instance.
|
|
|
1577
1538
|
## Call Signature
|
|
1578
1539
|
|
|
1579
1540
|
```ts
|
|
1580
|
-
function isSet(value): value is Set<unknown>;
|
|
1541
|
+
function isSet(value: unknown): value is Set<unknown>;
|
|
1581
1542
|
```
|
|
1582
1543
|
|
|
1583
1544
|
Type guard that checks whether a value is a Set instance.
|
|
1584
1545
|
|
|
1585
1546
|
### Parameters
|
|
1586
1547
|
|
|
1587
|
-
|
|
1588
|
-
|
|
1589
|
-
`unknown`
|
|
1548
|
+
| Parameter | Type |
|
|
1549
|
+
| ------ | ------ |
|
|
1550
|
+
| `value` | `unknown` |
|
|
1590
1551
|
|
|
1591
1552
|
### Returns
|
|
1592
1553
|
|
|
@@ -1595,22 +1556,22 @@ Type guard that checks whether a value is a Set instance.
|
|
|
1595
1556
|
## Call Signature
|
|
1596
1557
|
|
|
1597
1558
|
```ts
|
|
1598
|
-
function isSet<T>(value): value is Extract<T, Set<unknown>>;
|
|
1559
|
+
function isSet<T>(value: unknown): value is Extract<T, Set<unknown>>;
|
|
1599
1560
|
```
|
|
1600
1561
|
|
|
1601
1562
|
Type guard that checks whether a value is a Set instance.
|
|
1602
1563
|
|
|
1603
1564
|
### Type Parameters
|
|
1604
1565
|
|
|
1605
|
-
|
|
1606
|
-
|
|
1607
|
-
`T` *extends* `Set`\<`unknown`\>
|
|
1566
|
+
| Type Parameter |
|
|
1567
|
+
| ------ |
|
|
1568
|
+
| `T` *extends* `Set`\<`unknown`\> |
|
|
1608
1569
|
|
|
1609
1570
|
### Parameters
|
|
1610
1571
|
|
|
1611
|
-
|
|
1612
|
-
|
|
1613
|
-
`unknown`
|
|
1572
|
+
| Parameter | Type |
|
|
1573
|
+
| ------ | ------ |
|
|
1574
|
+
| `value` | `unknown` |
|
|
1614
1575
|
|
|
1615
1576
|
### Returns
|
|
1616
1577
|
|
|
@@ -1625,16 +1586,16 @@ Type guard that checks whether a value is a Set instance.
|
|
|
1625
1586
|
## Call Signature
|
|
1626
1587
|
|
|
1627
1588
|
```ts
|
|
1628
|
-
function isString(value): value is string;
|
|
1589
|
+
function isString(value: unknown): value is string;
|
|
1629
1590
|
```
|
|
1630
1591
|
|
|
1631
1592
|
Type guard that checks whether a value is a string.
|
|
1632
1593
|
|
|
1633
1594
|
### Parameters
|
|
1634
1595
|
|
|
1635
|
-
|
|
1636
|
-
|
|
1637
|
-
`unknown`
|
|
1596
|
+
| Parameter | Type |
|
|
1597
|
+
| ------ | ------ |
|
|
1598
|
+
| `value` | `unknown` |
|
|
1638
1599
|
|
|
1639
1600
|
### Returns
|
|
1640
1601
|
|
|
@@ -1643,22 +1604,22 @@ Type guard that checks whether a value is a string.
|
|
|
1643
1604
|
## Call Signature
|
|
1644
1605
|
|
|
1645
1606
|
```ts
|
|
1646
|
-
function isString<T>(value): value is Extract<T, string>;
|
|
1607
|
+
function isString<T>(value: T): value is Extract<T, string>;
|
|
1647
1608
|
```
|
|
1648
1609
|
|
|
1649
1610
|
Type guard that checks whether a value is a string.
|
|
1650
1611
|
|
|
1651
1612
|
### Type Parameters
|
|
1652
1613
|
|
|
1653
|
-
|
|
1654
|
-
|
|
1655
|
-
`T` *extends* `string`
|
|
1614
|
+
| Type Parameter |
|
|
1615
|
+
| ------ |
|
|
1616
|
+
| `T` *extends* `string` |
|
|
1656
1617
|
|
|
1657
1618
|
### Parameters
|
|
1658
1619
|
|
|
1659
|
-
|
|
1660
|
-
|
|
1661
|
-
`T`
|
|
1620
|
+
| Parameter | Type |
|
|
1621
|
+
| ------ | ------ |
|
|
1622
|
+
| `value` | `T` |
|
|
1662
1623
|
|
|
1663
1624
|
### Returns
|
|
1664
1625
|
|
|
@@ -1673,16 +1634,16 @@ Type guard that checks whether a value is a string.
|
|
|
1673
1634
|
## Call Signature
|
|
1674
1635
|
|
|
1675
1636
|
```ts
|
|
1676
|
-
function isSymbol(value): value is symbol;
|
|
1637
|
+
function isSymbol(value: unknown): value is symbol;
|
|
1677
1638
|
```
|
|
1678
1639
|
|
|
1679
1640
|
Type guard that checks whether a value is a symbol.
|
|
1680
1641
|
|
|
1681
1642
|
### Parameters
|
|
1682
1643
|
|
|
1683
|
-
|
|
1684
|
-
|
|
1685
|
-
`unknown`
|
|
1644
|
+
| Parameter | Type |
|
|
1645
|
+
| ------ | ------ |
|
|
1646
|
+
| `value` | `unknown` |
|
|
1686
1647
|
|
|
1687
1648
|
### Returns
|
|
1688
1649
|
|
|
@@ -1691,22 +1652,22 @@ Type guard that checks whether a value is a symbol.
|
|
|
1691
1652
|
## Call Signature
|
|
1692
1653
|
|
|
1693
1654
|
```ts
|
|
1694
|
-
function isSymbol<T>(value): value is Extract<T, symbol>;
|
|
1655
|
+
function isSymbol<T>(value: T): value is Extract<T, symbol>;
|
|
1695
1656
|
```
|
|
1696
1657
|
|
|
1697
1658
|
Type guard that checks whether a value is a symbol.
|
|
1698
1659
|
|
|
1699
1660
|
### Type Parameters
|
|
1700
1661
|
|
|
1701
|
-
|
|
1702
|
-
|
|
1703
|
-
`T` *extends* `symbol`
|
|
1662
|
+
| Type Parameter |
|
|
1663
|
+
| ------ |
|
|
1664
|
+
| `T` *extends* `symbol` |
|
|
1704
1665
|
|
|
1705
1666
|
### Parameters
|
|
1706
1667
|
|
|
1707
|
-
|
|
1708
|
-
|
|
1709
|
-
`T`
|
|
1668
|
+
| Parameter | Type |
|
|
1669
|
+
| ------ | ------ |
|
|
1670
|
+
| `value` | `T` |
|
|
1710
1671
|
|
|
1711
1672
|
### Returns
|
|
1712
1673
|
|
|
@@ -1721,22 +1682,22 @@ Type guard that checks whether a value is a symbol.
|
|
|
1721
1682
|
## Call Signature
|
|
1722
1683
|
|
|
1723
1684
|
```ts
|
|
1724
|
-
function isTruthy<T>(value): value is Exclude<T, false | "" | 0 | 0n | null | undefined>;
|
|
1685
|
+
function isTruthy<T>(value: T): value is Exclude<T, false | "" | 0 | 0n | null | undefined>;
|
|
1725
1686
|
```
|
|
1726
1687
|
|
|
1727
1688
|
Type guard that checks whether a value is truthy (not 0, null, undefined, false, '', or 0n).
|
|
1728
1689
|
|
|
1729
1690
|
### Type Parameters
|
|
1730
1691
|
|
|
1731
|
-
|
|
1732
|
-
|
|
1733
|
-
`T`
|
|
1692
|
+
| Type Parameter |
|
|
1693
|
+
| ------ |
|
|
1694
|
+
| `T` |
|
|
1734
1695
|
|
|
1735
1696
|
### Parameters
|
|
1736
1697
|
|
|
1737
|
-
|
|
1738
|
-
|
|
1739
|
-
`T`
|
|
1698
|
+
| Parameter | Type |
|
|
1699
|
+
| ------ | ------ |
|
|
1700
|
+
| `value` | `T` |
|
|
1740
1701
|
|
|
1741
1702
|
### Returns
|
|
1742
1703
|
|
|
@@ -1745,22 +1706,22 @@ value is Exclude\<T, false \| "" \| 0 \| 0n \| null \| undefined\>
|
|
|
1745
1706
|
## Call Signature
|
|
1746
1707
|
|
|
1747
1708
|
```ts
|
|
1748
|
-
function isTruthy<T>(value): value is Extract<T, true>;
|
|
1709
|
+
function isTruthy<T>(value: T): value is Extract<T, true>;
|
|
1749
1710
|
```
|
|
1750
1711
|
|
|
1751
1712
|
Type guard that checks whether a value is truthy (not 0, null, undefined, false, '', or 0n).
|
|
1752
1713
|
|
|
1753
1714
|
### Type Parameters
|
|
1754
1715
|
|
|
1755
|
-
|
|
1756
|
-
|
|
1757
|
-
`T` *extends* `boolean`
|
|
1716
|
+
| Type Parameter |
|
|
1717
|
+
| ------ |
|
|
1718
|
+
| `T` *extends* `boolean` |
|
|
1758
1719
|
|
|
1759
1720
|
### Parameters
|
|
1760
1721
|
|
|
1761
|
-
|
|
1762
|
-
|
|
1763
|
-
`T`
|
|
1722
|
+
| Parameter | Type |
|
|
1723
|
+
| ------ | ------ |
|
|
1724
|
+
| `value` | `T` |
|
|
1764
1725
|
|
|
1765
1726
|
### Returns
|
|
1766
1727
|
|
|
@@ -1769,22 +1730,22 @@ Type guard that checks whether a value is truthy (not 0, null, undefined, false,
|
|
|
1769
1730
|
## Call Signature
|
|
1770
1731
|
|
|
1771
1732
|
```ts
|
|
1772
|
-
function isTruthy<T>(value): value is Extract<T, number>;
|
|
1733
|
+
function isTruthy<T>(value: T): value is Extract<T, number>;
|
|
1773
1734
|
```
|
|
1774
1735
|
|
|
1775
1736
|
Type guard that checks whether a value is truthy (not 0, null, undefined, false, '', or 0n).
|
|
1776
1737
|
|
|
1777
1738
|
### Type Parameters
|
|
1778
1739
|
|
|
1779
|
-
|
|
1780
|
-
|
|
1781
|
-
`T` *extends* `number`
|
|
1740
|
+
| Type Parameter |
|
|
1741
|
+
| ------ |
|
|
1742
|
+
| `T` *extends* `number` |
|
|
1782
1743
|
|
|
1783
1744
|
### Parameters
|
|
1784
1745
|
|
|
1785
|
-
|
|
1786
|
-
|
|
1787
|
-
`T`
|
|
1746
|
+
| Parameter | Type |
|
|
1747
|
+
| ------ | ------ |
|
|
1748
|
+
| `value` | `T` |
|
|
1788
1749
|
|
|
1789
1750
|
### Returns
|
|
1790
1751
|
|
|
@@ -1793,22 +1754,22 @@ Type guard that checks whether a value is truthy (not 0, null, undefined, false,
|
|
|
1793
1754
|
## Call Signature
|
|
1794
1755
|
|
|
1795
1756
|
```ts
|
|
1796
|
-
function isTruthy<T>(value): value is Extract<T, bigint>;
|
|
1757
|
+
function isTruthy<T>(value: T): value is Extract<T, bigint>;
|
|
1797
1758
|
```
|
|
1798
1759
|
|
|
1799
1760
|
Type guard that checks whether a value is truthy (not 0, null, undefined, false, '', or 0n).
|
|
1800
1761
|
|
|
1801
1762
|
### Type Parameters
|
|
1802
1763
|
|
|
1803
|
-
|
|
1804
|
-
|
|
1805
|
-
`T` *extends* `bigint`
|
|
1764
|
+
| Type Parameter |
|
|
1765
|
+
| ------ |
|
|
1766
|
+
| `T` *extends* `bigint` |
|
|
1806
1767
|
|
|
1807
1768
|
### Parameters
|
|
1808
1769
|
|
|
1809
|
-
|
|
1810
|
-
|
|
1811
|
-
`T`
|
|
1770
|
+
| Parameter | Type |
|
|
1771
|
+
| ------ | ------ |
|
|
1772
|
+
| `value` | `T` |
|
|
1812
1773
|
|
|
1813
1774
|
### Returns
|
|
1814
1775
|
|
|
@@ -1817,22 +1778,22 @@ Type guard that checks whether a value is truthy (not 0, null, undefined, false,
|
|
|
1817
1778
|
## Call Signature
|
|
1818
1779
|
|
|
1819
1780
|
```ts
|
|
1820
|
-
function isTruthy<T>(value): value is Extract<T, null>;
|
|
1781
|
+
function isTruthy<T>(value: T): value is Extract<T, null>;
|
|
1821
1782
|
```
|
|
1822
1783
|
|
|
1823
1784
|
Type guard that checks whether a value is truthy (not 0, null, undefined, false, '', or 0n).
|
|
1824
1785
|
|
|
1825
1786
|
### Type Parameters
|
|
1826
1787
|
|
|
1827
|
-
|
|
1828
|
-
|
|
1829
|
-
`T` *extends* `null`
|
|
1788
|
+
| Type Parameter |
|
|
1789
|
+
| ------ |
|
|
1790
|
+
| `T` *extends* `null` |
|
|
1830
1791
|
|
|
1831
1792
|
### Parameters
|
|
1832
1793
|
|
|
1833
|
-
|
|
1834
|
-
|
|
1835
|
-
`T`
|
|
1794
|
+
| Parameter | Type |
|
|
1795
|
+
| ------ | ------ |
|
|
1796
|
+
| `value` | `T` |
|
|
1836
1797
|
|
|
1837
1798
|
### Returns
|
|
1838
1799
|
|
|
@@ -1841,22 +1802,22 @@ Type guard that checks whether a value is truthy (not 0, null, undefined, false,
|
|
|
1841
1802
|
## Call Signature
|
|
1842
1803
|
|
|
1843
1804
|
```ts
|
|
1844
|
-
function isTruthy<T>(value): value is Extract<T, undefined>;
|
|
1805
|
+
function isTruthy<T>(value: T): value is Extract<T, undefined>;
|
|
1845
1806
|
```
|
|
1846
1807
|
|
|
1847
1808
|
Type guard that checks whether a value is truthy (not 0, null, undefined, false, '', or 0n).
|
|
1848
1809
|
|
|
1849
1810
|
### Type Parameters
|
|
1850
1811
|
|
|
1851
|
-
|
|
1852
|
-
|
|
1853
|
-
`T` *extends* `undefined`
|
|
1812
|
+
| Type Parameter |
|
|
1813
|
+
| ------ |
|
|
1814
|
+
| `T` *extends* `undefined` |
|
|
1854
1815
|
|
|
1855
1816
|
### Parameters
|
|
1856
1817
|
|
|
1857
|
-
|
|
1858
|
-
|
|
1859
|
-
`T`
|
|
1818
|
+
| Parameter | Type |
|
|
1819
|
+
| ------ | ------ |
|
|
1820
|
+
| `value` | `T` |
|
|
1860
1821
|
|
|
1861
1822
|
### Returns
|
|
1862
1823
|
|
|
@@ -1865,22 +1826,22 @@ Type guard that checks whether a value is truthy (not 0, null, undefined, false,
|
|
|
1865
1826
|
## Call Signature
|
|
1866
1827
|
|
|
1867
1828
|
```ts
|
|
1868
|
-
function isTruthy<T>(value): value is Extract<T, string>;
|
|
1829
|
+
function isTruthy<T>(value: T): value is Extract<T, string>;
|
|
1869
1830
|
```
|
|
1870
1831
|
|
|
1871
1832
|
Type guard that checks whether a value is truthy (not 0, null, undefined, false, '', or 0n).
|
|
1872
1833
|
|
|
1873
1834
|
### Type Parameters
|
|
1874
1835
|
|
|
1875
|
-
|
|
1876
|
-
|
|
1877
|
-
`T` *extends* `string`
|
|
1836
|
+
| Type Parameter |
|
|
1837
|
+
| ------ |
|
|
1838
|
+
| `T` *extends* `string` |
|
|
1878
1839
|
|
|
1879
1840
|
### Parameters
|
|
1880
1841
|
|
|
1881
|
-
|
|
1882
|
-
|
|
1883
|
-
`T`
|
|
1842
|
+
| Parameter | Type |
|
|
1843
|
+
| ------ | ------ |
|
|
1844
|
+
| `value` | `T` |
|
|
1884
1845
|
|
|
1885
1846
|
### Returns
|
|
1886
1847
|
|
|
@@ -1893,24 +1854,17 @@ Type guard that checks whether a value is truthy (not 0, null, undefined, false,
|
|
|
1893
1854
|
***
|
|
1894
1855
|
|
|
1895
1856
|
```ts
|
|
1896
|
-
function isType(value, expectedType): boolean;
|
|
1857
|
+
function isType(value: unknown, expectedType: FieldType): boolean;
|
|
1897
1858
|
```
|
|
1898
1859
|
|
|
1899
1860
|
Checks whether a value matches the expected field type, with correct handling for arrays and nulls.
|
|
1900
1861
|
|
|
1901
1862
|
## Parameters
|
|
1902
1863
|
|
|
1903
|
-
|
|
1904
|
-
|
|
1905
|
-
`unknown`
|
|
1906
|
-
|
|
1907
|
-
The value to check.
|
|
1908
|
-
|
|
1909
|
-
### expectedType
|
|
1910
|
-
|
|
1911
|
-
[`FieldType`](#../type-aliases/FieldType)
|
|
1912
|
-
|
|
1913
|
-
The expected type string.
|
|
1864
|
+
| Parameter | Type | Description |
|
|
1865
|
+
| ------ | ------ | ------ |
|
|
1866
|
+
| `value` | `unknown` | The value to check. |
|
|
1867
|
+
| `expectedType` | [`FieldType`](#../type-aliases/FieldType) | The expected type string. |
|
|
1914
1868
|
|
|
1915
1869
|
## Returns
|
|
1916
1870
|
|
|
@@ -1925,18 +1879,16 @@ True if the value matches the expected type.
|
|
|
1925
1879
|
***
|
|
1926
1880
|
|
|
1927
1881
|
```ts
|
|
1928
|
-
function isTypedArray(value): value is TypedArray;
|
|
1882
|
+
function isTypedArray(value: unknown): value is TypedArray;
|
|
1929
1883
|
```
|
|
1930
1884
|
|
|
1931
1885
|
Type guard that checks whether a value is a TypedArray (an array where every element is a TypedValue).
|
|
1932
1886
|
|
|
1933
1887
|
## Parameters
|
|
1934
1888
|
|
|
1935
|
-
|
|
1936
|
-
|
|
1937
|
-
`unknown`
|
|
1938
|
-
|
|
1939
|
-
The value to check.
|
|
1889
|
+
| Parameter | Type | Description |
|
|
1890
|
+
| ------ | ------ | ------ |
|
|
1891
|
+
| `value` | `unknown` | The value to check. |
|
|
1940
1892
|
|
|
1941
1893
|
## Returns
|
|
1942
1894
|
|
|
@@ -1951,18 +1903,16 @@ True if the value is an array of TypedValue elements.
|
|
|
1951
1903
|
***
|
|
1952
1904
|
|
|
1953
1905
|
```ts
|
|
1954
|
-
function isTypedKey(value): value is string | number | symbol;
|
|
1906
|
+
function isTypedKey(value: unknown): value is string | number | symbol;
|
|
1955
1907
|
```
|
|
1956
1908
|
|
|
1957
1909
|
Type guard that checks whether a value is a valid TypedKey (string, bigint, number, or symbol).
|
|
1958
1910
|
|
|
1959
1911
|
## Parameters
|
|
1960
1912
|
|
|
1961
|
-
|
|
1962
|
-
|
|
1963
|
-
`unknown`
|
|
1964
|
-
|
|
1965
|
-
The value to check.
|
|
1913
|
+
| Parameter | Type | Description |
|
|
1914
|
+
| ------ | ------ | ------ |
|
|
1915
|
+
| `value` | `unknown` | The value to check. |
|
|
1966
1916
|
|
|
1967
1917
|
## Returns
|
|
1968
1918
|
|
|
@@ -1977,18 +1927,16 @@ True if the value is a valid TypedKey.
|
|
|
1977
1927
|
***
|
|
1978
1928
|
|
|
1979
1929
|
```ts
|
|
1980
|
-
function isTypedObject(value): value is TypedObject;
|
|
1930
|
+
function isTypedObject(value: unknown): value is TypedObject;
|
|
1981
1931
|
```
|
|
1982
1932
|
|
|
1983
1933
|
Type guard that checks whether a value is a TypedObject (an object with TypedKey keys and TypedValue values).
|
|
1984
1934
|
|
|
1985
1935
|
## Parameters
|
|
1986
1936
|
|
|
1987
|
-
|
|
1988
|
-
|
|
1989
|
-
`unknown`
|
|
1990
|
-
|
|
1991
|
-
The value to check.
|
|
1937
|
+
| Parameter | Type | Description |
|
|
1938
|
+
| ------ | ------ | ------ |
|
|
1939
|
+
| `value` | `unknown` | The value to check. |
|
|
1992
1940
|
|
|
1993
1941
|
## Returns
|
|
1994
1942
|
|
|
@@ -2003,18 +1951,16 @@ True if the value is a valid TypedObject.
|
|
|
2003
1951
|
***
|
|
2004
1952
|
|
|
2005
1953
|
```ts
|
|
2006
|
-
function isTypedValue(value): value is TypedValue;
|
|
1954
|
+
function isTypedValue(value: unknown): value is TypedValue;
|
|
2007
1955
|
```
|
|
2008
1956
|
|
|
2009
1957
|
Type guard that checks whether a value is a valid TypedValue.
|
|
2010
1958
|
|
|
2011
1959
|
## Parameters
|
|
2012
1960
|
|
|
2013
|
-
|
|
2014
|
-
|
|
2015
|
-
`unknown`
|
|
2016
|
-
|
|
2017
|
-
The value to check.
|
|
1961
|
+
| Parameter | Type | Description |
|
|
1962
|
+
| ------ | ------ | ------ |
|
|
1963
|
+
| `value` | `unknown` | The value to check. |
|
|
2018
1964
|
|
|
2019
1965
|
## Returns
|
|
2020
1966
|
|
|
@@ -2031,16 +1977,16 @@ True if the value is a string, number, boolean, null, TypedObject, or TypedArray
|
|
|
2031
1977
|
## Call Signature
|
|
2032
1978
|
|
|
2033
1979
|
```ts
|
|
2034
|
-
function isUndefined(value): value is undefined;
|
|
1980
|
+
function isUndefined(value: unknown): value is undefined;
|
|
2035
1981
|
```
|
|
2036
1982
|
|
|
2037
1983
|
Type guard that checks whether a value is undefined.
|
|
2038
1984
|
|
|
2039
1985
|
### Parameters
|
|
2040
1986
|
|
|
2041
|
-
|
|
2042
|
-
|
|
2043
|
-
`unknown`
|
|
1987
|
+
| Parameter | Type |
|
|
1988
|
+
| ------ | ------ |
|
|
1989
|
+
| `value` | `unknown` |
|
|
2044
1990
|
|
|
2045
1991
|
### Returns
|
|
2046
1992
|
|
|
@@ -2049,22 +1995,22 @@ Type guard that checks whether a value is undefined.
|
|
|
2049
1995
|
## Call Signature
|
|
2050
1996
|
|
|
2051
1997
|
```ts
|
|
2052
|
-
function isUndefined<T>(value): value is Extract<T, undefined>;
|
|
1998
|
+
function isUndefined<T>(value: T): value is Extract<T, undefined>;
|
|
2053
1999
|
```
|
|
2054
2000
|
|
|
2055
2001
|
Type guard that checks whether a value is undefined.
|
|
2056
2002
|
|
|
2057
2003
|
### Type Parameters
|
|
2058
2004
|
|
|
2059
|
-
|
|
2060
|
-
|
|
2061
|
-
`T`
|
|
2005
|
+
| Type Parameter |
|
|
2006
|
+
| ------ |
|
|
2007
|
+
| `T` |
|
|
2062
2008
|
|
|
2063
2009
|
### Parameters
|
|
2064
2010
|
|
|
2065
|
-
|
|
2066
|
-
|
|
2067
|
-
`T`
|
|
2011
|
+
| Parameter | Type |
|
|
2012
|
+
| ------ | ------ |
|
|
2013
|
+
| `value` | `T` |
|
|
2068
2014
|
|
|
2069
2015
|
### Returns
|
|
2070
2016
|
|
|
@@ -2079,16 +2025,16 @@ Type guard that checks whether a value is undefined.
|
|
|
2079
2025
|
## Call Signature
|
|
2080
2026
|
|
|
2081
2027
|
```ts
|
|
2082
|
-
function isUndefinedOrNull(value): value is null | undefined;
|
|
2028
|
+
function isUndefinedOrNull(value: unknown): value is null | undefined;
|
|
2083
2029
|
```
|
|
2084
2030
|
|
|
2085
2031
|
Type guard that checks whether a value is undefined or null.
|
|
2086
2032
|
|
|
2087
2033
|
### Parameters
|
|
2088
2034
|
|
|
2089
|
-
|
|
2090
|
-
|
|
2091
|
-
`unknown`
|
|
2035
|
+
| Parameter | Type |
|
|
2036
|
+
| ------ | ------ |
|
|
2037
|
+
| `value` | `unknown` |
|
|
2092
2038
|
|
|
2093
2039
|
### Returns
|
|
2094
2040
|
|
|
@@ -2097,22 +2043,22 @@ value is null \| undefined
|
|
|
2097
2043
|
## Call Signature
|
|
2098
2044
|
|
|
2099
2045
|
```ts
|
|
2100
|
-
function isUndefinedOrNull<T>(value): value is Extract<T, null | undefined>;
|
|
2046
|
+
function isUndefinedOrNull<T>(value: T): value is Extract<T, null | undefined>;
|
|
2101
2047
|
```
|
|
2102
2048
|
|
|
2103
2049
|
Type guard that checks whether a value is undefined or null.
|
|
2104
2050
|
|
|
2105
2051
|
### Type Parameters
|
|
2106
2052
|
|
|
2107
|
-
|
|
2108
|
-
|
|
2109
|
-
`T`
|
|
2053
|
+
| Type Parameter |
|
|
2054
|
+
| ------ |
|
|
2055
|
+
| `T` |
|
|
2110
2056
|
|
|
2111
2057
|
### Parameters
|
|
2112
2058
|
|
|
2113
|
-
|
|
2114
|
-
|
|
2115
|
-
`T`
|
|
2059
|
+
| Parameter | Type |
|
|
2060
|
+
| ------ | ------ |
|
|
2061
|
+
| `value` | `T` |
|
|
2116
2062
|
|
|
2117
2063
|
### Returns
|
|
2118
2064
|
|
|
@@ -2125,18 +2071,16 @@ value is Extract\<T, null \| undefined\>
|
|
|
2125
2071
|
***
|
|
2126
2072
|
|
|
2127
2073
|
```ts
|
|
2128
|
-
function isValidTypedFieldPair(pair): pair is [key: string | number | symbol, value: TypedValue];
|
|
2074
|
+
function isValidTypedFieldPair(pair: [unknown, unknown]): pair is [key: string | number | symbol, value: TypedValue];
|
|
2129
2075
|
```
|
|
2130
2076
|
|
|
2131
2077
|
Type guard that checks whether a key-value pair has a valid TypedKey and TypedValue.
|
|
2132
2078
|
|
|
2133
2079
|
## Parameters
|
|
2134
2080
|
|
|
2135
|
-
|
|
2136
|
-
|
|
2137
|
-
\[`unknown`, `unknown`\]
|
|
2138
|
-
|
|
2139
|
-
A tuple of [key, value] to validate.
|
|
2081
|
+
| Parameter | Type | Description |
|
|
2082
|
+
| ------ | ------ | ------ |
|
|
2083
|
+
| `pair` | \[`unknown`, `unknown`\] | A tuple of [key, value] to validate. |
|
|
2140
2084
|
|
|
2141
2085
|
## Returns
|
|
2142
2086
|
|
|
@@ -2153,16 +2097,16 @@ True if the key is a TypedKey and the value is a TypedValue.
|
|
|
2153
2097
|
## Call Signature
|
|
2154
2098
|
|
|
2155
2099
|
```ts
|
|
2156
|
-
function isWeakMap(value): value is WeakMap<WeakKey, unknown>;
|
|
2100
|
+
function isWeakMap(value: unknown): value is WeakMap<WeakKey, unknown>;
|
|
2157
2101
|
```
|
|
2158
2102
|
|
|
2159
2103
|
Type guard that checks whether a value is a WeakMap instance.
|
|
2160
2104
|
|
|
2161
2105
|
### Parameters
|
|
2162
2106
|
|
|
2163
|
-
|
|
2164
|
-
|
|
2165
|
-
`unknown`
|
|
2107
|
+
| Parameter | Type |
|
|
2108
|
+
| ------ | ------ |
|
|
2109
|
+
| `value` | `unknown` |
|
|
2166
2110
|
|
|
2167
2111
|
### Returns
|
|
2168
2112
|
|
|
@@ -2171,30 +2115,24 @@ Type guard that checks whether a value is a WeakMap instance.
|
|
|
2171
2115
|
## Call Signature
|
|
2172
2116
|
|
|
2173
2117
|
```ts
|
|
2174
|
-
function isWeakMap<K, V, T>(value): value is Extract<T, WeakMap<K, V>>;
|
|
2118
|
+
function isWeakMap<K, V, T>(value: T): value is Extract<T, WeakMap<K, V>>;
|
|
2175
2119
|
```
|
|
2176
2120
|
|
|
2177
2121
|
Type guard that checks whether a value is a WeakMap instance.
|
|
2178
2122
|
|
|
2179
2123
|
### Type Parameters
|
|
2180
2124
|
|
|
2181
|
-
|
|
2182
|
-
|
|
2183
|
-
`K` *extends* `WeakKey`
|
|
2184
|
-
|
|
2185
|
-
|
|
2186
|
-
|
|
2187
|
-
`V`
|
|
2188
|
-
|
|
2189
|
-
### T
|
|
2190
|
-
|
|
2191
|
-
`T` *extends* `WeakMap`\<`K`, `V`\>
|
|
2125
|
+
| Type Parameter |
|
|
2126
|
+
| ------ |
|
|
2127
|
+
| `K` *extends* `WeakKey` |
|
|
2128
|
+
| `V` |
|
|
2129
|
+
| `T` *extends* `WeakMap`\<`K`, `V`\> |
|
|
2192
2130
|
|
|
2193
2131
|
### Parameters
|
|
2194
2132
|
|
|
2195
|
-
|
|
2196
|
-
|
|
2197
|
-
`T`
|
|
2133
|
+
| Parameter | Type |
|
|
2134
|
+
| ------ | ------ |
|
|
2135
|
+
| `value` | `T` |
|
|
2198
2136
|
|
|
2199
2137
|
### Returns
|
|
2200
2138
|
|
|
@@ -2209,16 +2147,16 @@ Type guard that checks whether a value is a WeakMap instance.
|
|
|
2209
2147
|
## Call Signature
|
|
2210
2148
|
|
|
2211
2149
|
```ts
|
|
2212
|
-
function isWeakSet(value): value is WeakSet<WeakKey>;
|
|
2150
|
+
function isWeakSet(value: unknown): value is WeakSet<WeakKey>;
|
|
2213
2151
|
```
|
|
2214
2152
|
|
|
2215
2153
|
Type guard that checks whether a value is a WeakSet instance.
|
|
2216
2154
|
|
|
2217
2155
|
### Parameters
|
|
2218
2156
|
|
|
2219
|
-
|
|
2220
|
-
|
|
2221
|
-
`unknown`
|
|
2157
|
+
| Parameter | Type |
|
|
2158
|
+
| ------ | ------ |
|
|
2159
|
+
| `value` | `unknown` |
|
|
2222
2160
|
|
|
2223
2161
|
### Returns
|
|
2224
2162
|
|
|
@@ -2227,26 +2165,23 @@ Type guard that checks whether a value is a WeakSet instance.
|
|
|
2227
2165
|
## Call Signature
|
|
2228
2166
|
|
|
2229
2167
|
```ts
|
|
2230
|
-
function isWeakSet<K, T>(value): value is Extract<T, WeakSet<K>>;
|
|
2168
|
+
function isWeakSet<K, T>(value: T): value is Extract<T, WeakSet<K>>;
|
|
2231
2169
|
```
|
|
2232
2170
|
|
|
2233
2171
|
Type guard that checks whether a value is a WeakSet instance.
|
|
2234
2172
|
|
|
2235
2173
|
### Type Parameters
|
|
2236
2174
|
|
|
2237
|
-
|
|
2238
|
-
|
|
2239
|
-
`K` *extends* `WeakKey`
|
|
2240
|
-
|
|
2241
|
-
### T
|
|
2242
|
-
|
|
2243
|
-
`T` *extends* `WeakSet`\<`K`\>
|
|
2175
|
+
| Type Parameter |
|
|
2176
|
+
| ------ |
|
|
2177
|
+
| `K` *extends* `WeakKey` |
|
|
2178
|
+
| `T` *extends* `WeakSet`\<`K`\> |
|
|
2244
2179
|
|
|
2245
2180
|
### Parameters
|
|
2246
2181
|
|
|
2247
|
-
|
|
2248
|
-
|
|
2249
|
-
`T`
|
|
2182
|
+
| Parameter | Type |
|
|
2183
|
+
| ------ | ------ |
|
|
2184
|
+
| `value` | `T` |
|
|
2250
2185
|
|
|
2251
2186
|
### Returns
|
|
2252
2187
|
|
|
@@ -2259,24 +2194,22 @@ Type guard that checks whether a value is a WeakSet instance.
|
|
|
2259
2194
|
***
|
|
2260
2195
|
|
|
2261
2196
|
```ts
|
|
2262
|
-
function typeOf<T>(item): TypeOfTypes;
|
|
2197
|
+
function typeOf<T>(item: T): TypeOfTypes;
|
|
2263
2198
|
```
|
|
2264
2199
|
|
|
2265
2200
|
Extended typeof that distinguishes arrays from objects (unlike native `typeof`).
|
|
2266
2201
|
|
|
2267
2202
|
## Type Parameters
|
|
2268
2203
|
|
|
2269
|
-
|
|
2270
|
-
|
|
2271
|
-
`T`
|
|
2204
|
+
| Type Parameter |
|
|
2205
|
+
| ------ |
|
|
2206
|
+
| `T` |
|
|
2272
2207
|
|
|
2273
2208
|
## Parameters
|
|
2274
2209
|
|
|
2275
|
-
|
|
2276
|
-
|
|
2277
|
-
`T`
|
|
2278
|
-
|
|
2279
|
-
The value to check.
|
|
2210
|
+
| Parameter | Type | Description |
|
|
2211
|
+
| ------ | ------ | ------ |
|
|
2212
|
+
| `item` | `T` | The value to check. |
|
|
2280
2213
|
|
|
2281
2214
|
## Returns
|
|
2282
2215
|
|
|
@@ -2292,38 +2225,26 @@ The type of the item as a TypeOfTypes string.
|
|
|
2292
2225
|
|
|
2293
2226
|
```ts
|
|
2294
2227
|
function validateType<T>(
|
|
2295
|
-
typeName,
|
|
2296
|
-
value,
|
|
2297
|
-
optional
|
|
2228
|
+
typeName: TypeOfTypes,
|
|
2229
|
+
value: T,
|
|
2230
|
+
optional?: boolean): [T | undefined, Error[]];
|
|
2298
2231
|
```
|
|
2299
2232
|
|
|
2300
2233
|
Validates that a value matches the expected type, returning the value and any errors.
|
|
2301
2234
|
|
|
2302
2235
|
## Type Parameters
|
|
2303
2236
|
|
|
2304
|
-
|
|
2305
|
-
|
|
2306
|
-
`T`
|
|
2237
|
+
| Type Parameter |
|
|
2238
|
+
| ------ |
|
|
2239
|
+
| `T` |
|
|
2307
2240
|
|
|
2308
2241
|
## Parameters
|
|
2309
2242
|
|
|
2310
|
-
|
|
2311
|
-
|
|
2312
|
-
[`TypeOfTypes`](#../type-aliases/TypeOfTypes)
|
|
2313
|
-
|
|
2314
|
-
|
|
2315
|
-
|
|
2316
|
-
### value
|
|
2317
|
-
|
|
2318
|
-
`T`
|
|
2319
|
-
|
|
2320
|
-
The value to validate.
|
|
2321
|
-
|
|
2322
|
-
### optional?
|
|
2323
|
-
|
|
2324
|
-
`boolean` = `false`
|
|
2325
|
-
|
|
2326
|
-
If true, undefined values are accepted without error.
|
|
2243
|
+
| Parameter | Type | Default value | Description |
|
|
2244
|
+
| ------ | ------ | ------ | ------ |
|
|
2245
|
+
| `typeName` | [`TypeOfTypes`](#../type-aliases/TypeOfTypes) | `undefined` | The expected type name. |
|
|
2246
|
+
| `value` | `T` | `undefined` | The value to validate. |
|
|
2247
|
+
| `optional` | `boolean` | `false` | If true, undefined values are accepted without error. |
|
|
2327
2248
|
|
|
2328
2249
|
## Returns
|
|
2329
2250
|
|
|
@@ -2340,16 +2261,16 @@ A tuple of [value or undefined, array of errors].
|
|
|
2340
2261
|
***
|
|
2341
2262
|
|
|
2342
2263
|
```ts
|
|
2343
|
-
type AnyFunction = (...args) => unknown;
|
|
2264
|
+
type AnyFunction = (...args: unknown[]) => unknown;
|
|
2344
2265
|
```
|
|
2345
2266
|
|
|
2346
2267
|
A function type that accepts any arguments and returns unknown.
|
|
2347
2268
|
|
|
2348
2269
|
## Parameters
|
|
2349
2270
|
|
|
2350
|
-
|
|
2351
|
-
|
|
2352
|
-
...`unknown`[]
|
|
2271
|
+
| Parameter | Type |
|
|
2272
|
+
| ------ | ------ |
|
|
2273
|
+
| ...`args` | `unknown`[] |
|
|
2353
2274
|
|
|
2354
2275
|
## Returns
|
|
2355
2276
|
|
|
@@ -2369,13 +2290,10 @@ Creates a branded type by intersecting base type T with brand type B, enabling n
|
|
|
2369
2290
|
|
|
2370
2291
|
## Type Parameters
|
|
2371
2292
|
|
|
2372
|
-
|
|
2373
|
-
|
|
2374
|
-
`T`
|
|
2375
|
-
|
|
2376
|
-
### B
|
|
2377
|
-
|
|
2378
|
-
`B`
|
|
2293
|
+
| Type Parameter |
|
|
2294
|
+
| ------ |
|
|
2295
|
+
| `T` |
|
|
2296
|
+
| `B` |
|
|
2379
2297
|
|
|
2380
2298
|
### <a id="FieldType"></a>FieldType
|
|
2381
2299
|
|
|
@@ -2404,22 +2322,22 @@ Union of string literals representing the possible types of an object field.
|
|
|
2404
2322
|
***
|
|
2405
2323
|
|
|
2406
2324
|
```ts
|
|
2407
|
-
type IdentityFunction<T> = (value) => value is T;
|
|
2325
|
+
type IdentityFunction<T> = (value: unknown) => value is T;
|
|
2408
2326
|
```
|
|
2409
2327
|
|
|
2410
2328
|
A type guard function that narrows an unknown value to type T.
|
|
2411
2329
|
|
|
2412
2330
|
## Type Parameters
|
|
2413
2331
|
|
|
2414
|
-
|
|
2415
|
-
|
|
2416
|
-
`T`
|
|
2332
|
+
| Type Parameter |
|
|
2333
|
+
| ------ |
|
|
2334
|
+
| `T` |
|
|
2417
2335
|
|
|
2418
2336
|
## Parameters
|
|
2419
2337
|
|
|
2420
|
-
|
|
2421
|
-
|
|
2422
|
-
`unknown`
|
|
2338
|
+
| Parameter | Type |
|
|
2339
|
+
| ------ | ------ |
|
|
2340
|
+
| `value` | `unknown` |
|
|
2423
2341
|
|
|
2424
2342
|
## Returns
|
|
2425
2343
|
|
|
@@ -2498,9 +2416,9 @@ A valid key for a typed object. Defaults to string | number | symbol unless narr
|
|
|
2498
2416
|
|
|
2499
2417
|
## Type Parameters
|
|
2500
2418
|
|
|
2501
|
-
|
|
2502
|
-
|
|
2503
|
-
`T` *extends* `string` \| `void`
|
|
2419
|
+
| Type Parameter | Default type |
|
|
2420
|
+
| ------ | ------ |
|
|
2421
|
+
| `T` *extends* `string` \| `void` | `void` |
|
|
2504
2422
|
|
|
2505
2423
|
### <a id="TypedObject"></a>TypedObject
|
|
2506
2424
|
|