@augment-vir/assert 31.0.0 → 31.1.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/assertions/boolean.d.ts +20 -26
- package/dist/assertions/boolean.js +185 -41
- package/dist/assertions/boundary.d.ts +40 -256
- package/dist/assertions/boundary.js +265 -229
- package/dist/assertions/enum.d.ts +12 -13
- package/dist/assertions/enum.js +98 -20
- package/dist/assertions/equality/entry-equality.d.ts +11 -15
- package/dist/assertions/equality/entry-equality.js +210 -43
- package/dist/assertions/equality/json-equality.d.ts +11 -15
- package/dist/assertions/equality/json-equality.js +144 -43
- package/dist/assertions/equality/simple-equality.d.ts +39 -46
- package/dist/assertions/equality/simple-equality.js +316 -61
- package/dist/assertions/extendable-assertions.d.ts +0 -12
- package/dist/assertions/extendable-assertions.js +0 -12
- package/dist/assertions/http.d.ts +10 -14
- package/dist/assertions/http.js +96 -28
- package/dist/assertions/instance.d.ts +10 -18
- package/dist/assertions/instance.js +92 -26
- package/dist/assertions/keys.d.ts +59 -138
- package/dist/assertions/keys.js +279 -162
- package/dist/assertions/length.d.ts +30 -212
- package/dist/assertions/length.js +117 -175
- package/dist/assertions/nullish.d.ts +8 -20
- package/dist/assertions/nullish.js +85 -27
- package/dist/assertions/numeric.d.ts +67 -81
- package/dist/assertions/numeric.js +564 -133
- package/dist/assertions/output.d.ts +2 -3
- package/dist/assertions/output.js +1 -7
- package/dist/assertions/primitive.d.ts +33 -40
- package/dist/assertions/primitive.js +232 -66
- package/dist/assertions/promise.d.ts +20 -30
- package/dist/assertions/promise.js +244 -53
- package/dist/assertions/regexp.d.ts +12 -14
- package/dist/assertions/regexp.js +84 -21
- package/dist/assertions/runtime-type.d.ts +99 -150
- package/dist/assertions/runtime-type.js +805 -229
- package/dist/assertions/throws.d.ts +24 -25
- package/dist/assertions/throws.js +43 -5
- package/dist/assertions/uuid.d.ts +11 -16
- package/dist/assertions/uuid.js +91 -22
- package/dist/assertions/values.d.ts +81 -210
- package/dist/assertions/values.js +627 -234
- package/dist/augments/guards/assert-wrap.d.ts +7 -4
- package/dist/augments/guards/assert-wrap.js +5 -4
- package/dist/augments/guards/check-wrap.d.ts +7 -5
- package/dist/augments/guards/check-wrap.js +5 -4
- package/dist/augments/guards/check.d.ts +5 -5
- package/dist/augments/guards/check.js +5 -4
- package/dist/augments/guards/wait-until.d.ts +8 -4
- package/dist/augments/guards/wait-until.js +7 -8
- package/dist/guard-types/guard-group.d.ts +5 -2
- package/dist/guard-types/wait-until-function.d.ts +2 -10
- package/dist/guard-types/wait-until-function.js +1 -9
- package/dist/index.d.ts +1 -0
- package/package.json +2 -2
- package/dist/guard-types/assert-wrap-function.d.ts +0 -12
- package/dist/guard-types/assert-wrap-function.js +0 -14
- package/dist/guard-types/check-function.d.ts +0 -14
- package/dist/guard-types/check-function.js +0 -22
- package/dist/guard-types/check-wrap-wrapper-function.d.ts +0 -12
- package/dist/guard-types/check-wrap-wrapper-function.js +0 -19
- package/dist/guard-types/guard-override.d.ts +0 -4
- package/dist/guard-types/guard-override.js +0 -10
|
@@ -1,27 +1,6 @@
|
|
|
1
1
|
import { type AnyFunction, type MaybePromise, type NarrowToActual, type NarrowToExpected, type UnknownObject } from '@augment-vir/core';
|
|
2
|
-
import { autoGuardSymbol } from '../guard-types/guard-override.js';
|
|
3
2
|
import { type WaitUntilOptions } from '../guard-types/wait-until-function.js';
|
|
4
|
-
type ArrayNarrow<Actual> =
|
|
5
|
-
declare function isNotArray<const Actual>(actual: Actual, failureMessage?: string | undefined): asserts actual is Exclude<Actual, ReadonlyArray<unknown>>;
|
|
6
|
-
declare function isNotBigInt<const Actual>(actual: Actual, failureMessage?: string | undefined): asserts actual is Exclude<Actual, bigint>;
|
|
7
|
-
declare function isNotBoolean<const Actual>(actual: Actual, failureMessage?: string | undefined): asserts actual is Exclude<Actual, boolean>;
|
|
8
|
-
declare function isNotFunction<const Actual>(actual: Actual, failureMessage?: string | undefined): asserts actual is Exclude<Actual, AnyFunction>;
|
|
9
|
-
declare function isNotNumber<const Actual>(actual: Actual, failureMessage?: string | undefined): asserts actual is Exclude<Actual, number>;
|
|
10
|
-
declare function isNotObject<const Actual>(actual: Actual, failureMessage?: string | undefined): asserts actual is Exclude<Actual, UnknownObject>;
|
|
11
|
-
declare function isNotString<const Actual>(actual: Actual, failureMessage?: string | undefined): asserts actual is Exclude<Actual, string>;
|
|
12
|
-
declare function isNotSymbol<const Actual>(actual: Actual, failureMessage?: string | undefined): asserts actual is Exclude<Actual, symbol>;
|
|
13
|
-
declare function isNotUndefined<const Actual>(actual: Actual, failureMessage?: string | undefined): asserts actual is Exclude<Actual, undefined>;
|
|
14
|
-
declare function isNotNull<const Actual>(actual: Actual, failureMessage?: string | undefined): asserts actual is Exclude<Actual, null>;
|
|
15
|
-
declare function isArray<const Actual>(actual: Actual, failureMessage?: string | undefined): asserts actual is ArrayNarrow<Actual>;
|
|
16
|
-
declare function isBigInt(actual: unknown, failureMessage?: string | undefined): asserts actual is bigint;
|
|
17
|
-
declare function isBoolean(actual: unknown, failureMessage?: string | undefined): asserts actual is boolean;
|
|
18
|
-
declare function isFunction<const Actual>(actual: Actual, failureMessage?: string | undefined): asserts actual is NarrowToActual<Actual, AnyFunction>;
|
|
19
|
-
export declare function isNumber(actual: unknown, failureMessage?: string | undefined): asserts actual is number;
|
|
20
|
-
declare function isObject(actual: unknown, failureMessage?: string | undefined): asserts actual is UnknownObject;
|
|
21
|
-
declare function isString(actual: unknown, failureMessage?: string | undefined): asserts actual is string;
|
|
22
|
-
declare function isSymbol(actual: unknown, failureMessage?: string | undefined): asserts actual is symbol;
|
|
23
|
-
declare function isUndefined(actual: unknown, failureMessage?: string | undefined): asserts actual is undefined;
|
|
24
|
-
declare function isNull(actual: unknown, failureMessage?: string | undefined): asserts actual is null;
|
|
3
|
+
type ArrayNarrow<Actual> = NarrowToExpected<Actual, unknown[]> extends never ? NarrowToExpected<Actual, ReadonlyArray<unknown>> extends never ? unknown[] extends Actual ? unknown[] : never : NarrowToExpected<Actual, ReadonlyArray<unknown>> : NarrowToExpected<Actual, unknown[]>;
|
|
25
4
|
export declare const runtimeTypeGuards: {
|
|
26
5
|
assert: {
|
|
27
6
|
/**
|
|
@@ -42,7 +21,7 @@ export declare const runtimeTypeGuards: {
|
|
|
42
21
|
* @see
|
|
43
22
|
* - {@link assert.isNotArray} : the opposite assertion.
|
|
44
23
|
*/
|
|
45
|
-
isArray:
|
|
24
|
+
isArray<Actual>(this: void, actual: Actual, failureMessage?: string | undefined): asserts actual is ArrayNarrow<Actual>;
|
|
46
25
|
/**
|
|
47
26
|
* Asserts that a value is a BigInt.
|
|
48
27
|
*
|
|
@@ -61,7 +40,7 @@ export declare const runtimeTypeGuards: {
|
|
|
61
40
|
* @see
|
|
62
41
|
* - {@link assert.isNotBigInt} : the opposite assertion.
|
|
63
42
|
*/
|
|
64
|
-
isBigInt:
|
|
43
|
+
isBigInt(this: void, actual: unknown, failureMessage?: string | undefined): asserts actual is bigint;
|
|
65
44
|
/**
|
|
66
45
|
* Asserts that a value is a boolean.
|
|
67
46
|
*
|
|
@@ -80,7 +59,7 @@ export declare const runtimeTypeGuards: {
|
|
|
80
59
|
* @see
|
|
81
60
|
* - {@link assert.isNotBoolean} : the opposite assertion.
|
|
82
61
|
*/
|
|
83
|
-
isBoolean:
|
|
62
|
+
isBoolean(this: void, actual: unknown, failureMessage?: string | undefined): asserts actual is boolean;
|
|
84
63
|
/**
|
|
85
64
|
* Asserts that a value is a function.
|
|
86
65
|
*
|
|
@@ -99,7 +78,7 @@ export declare const runtimeTypeGuards: {
|
|
|
99
78
|
* @see
|
|
100
79
|
* - {@link assert.isNotFunction} : the opposite assertion.
|
|
101
80
|
*/
|
|
102
|
-
isFunction:
|
|
81
|
+
isFunction<Actual>(this: void, actual: Actual, failureMessage?: string | undefined): asserts actual is NarrowToActual<Actual, AnyFunction>;
|
|
103
82
|
/**
|
|
104
83
|
* Asserts that a value is exactly `null`.
|
|
105
84
|
*
|
|
@@ -118,7 +97,7 @@ export declare const runtimeTypeGuards: {
|
|
|
118
97
|
* @see
|
|
119
98
|
* - {@link assert.isNotFunction} : the opposite assertion.
|
|
120
99
|
*/
|
|
121
|
-
isNull:
|
|
100
|
+
isNull(this: void, actual: unknown, failureMessage?: string | undefined): asserts actual is null;
|
|
122
101
|
/**
|
|
123
102
|
* Asserts that a value is a number. This excludes `NaN`.
|
|
124
103
|
*
|
|
@@ -137,7 +116,7 @@ export declare const runtimeTypeGuards: {
|
|
|
137
116
|
* @see
|
|
138
117
|
* - {@link assert.isNotFunction} : the opposite assertion.
|
|
139
118
|
*/
|
|
140
|
-
isNumber:
|
|
119
|
+
isNumber(this: void, actual: unknown, failureMessage?: string | undefined): asserts actual is number;
|
|
141
120
|
/**
|
|
142
121
|
* Asserts that a value is an object. This excludes arrays.
|
|
143
122
|
*
|
|
@@ -156,7 +135,7 @@ export declare const runtimeTypeGuards: {
|
|
|
156
135
|
* @see
|
|
157
136
|
* - {@link assert.isNotFunction} : the opposite assertion.
|
|
158
137
|
*/
|
|
159
|
-
isObject:
|
|
138
|
+
isObject(this: void, actual: unknown, failureMessage?: string | undefined): asserts actual is UnknownObject;
|
|
160
139
|
/**
|
|
161
140
|
* Asserts that a value is a string.
|
|
162
141
|
*
|
|
@@ -175,7 +154,7 @@ export declare const runtimeTypeGuards: {
|
|
|
175
154
|
* @see
|
|
176
155
|
* - {@link assert.isNotFunction} : the opposite assertion.
|
|
177
156
|
*/
|
|
178
|
-
isString:
|
|
157
|
+
isString(this: void, actual: unknown, failureMessage?: string | undefined): asserts actual is string;
|
|
179
158
|
/**
|
|
180
159
|
* Asserts that a value is a symbol.
|
|
181
160
|
*
|
|
@@ -194,7 +173,7 @@ export declare const runtimeTypeGuards: {
|
|
|
194
173
|
* @see
|
|
195
174
|
* - {@link assert.isNotFunction} : the opposite assertion.
|
|
196
175
|
*/
|
|
197
|
-
isSymbol:
|
|
176
|
+
isSymbol(this: void, actual: unknown, failureMessage?: string | undefined): asserts actual is symbol;
|
|
198
177
|
/**
|
|
199
178
|
* Asserts that a value is exactly `undefined`.
|
|
200
179
|
*
|
|
@@ -213,7 +192,7 @@ export declare const runtimeTypeGuards: {
|
|
|
213
192
|
* @see
|
|
214
193
|
* - {@link assert.isNotFunction} : the opposite assertion.
|
|
215
194
|
*/
|
|
216
|
-
isUndefined:
|
|
195
|
+
isUndefined(this: void, actual: unknown, failureMessage?: string | undefined): asserts actual is undefined;
|
|
217
196
|
/**
|
|
218
197
|
* Asserts that a value is _not_ an array.
|
|
219
198
|
*
|
|
@@ -232,7 +211,7 @@ export declare const runtimeTypeGuards: {
|
|
|
232
211
|
* @see
|
|
233
212
|
* - {@link assert.isArray} : the opposite assertion.
|
|
234
213
|
*/
|
|
235
|
-
isNotArray:
|
|
214
|
+
isNotArray<Actual>(this: void, actual: Actual, failureMessage?: string | undefined): asserts actual is Exclude<Actual, ReadonlyArray<unknown>>;
|
|
236
215
|
/**
|
|
237
216
|
* Asserts that a value is _not_ a BigInt.
|
|
238
217
|
*
|
|
@@ -251,7 +230,7 @@ export declare const runtimeTypeGuards: {
|
|
|
251
230
|
* @see
|
|
252
231
|
* - {@link assert.isBigInt} : the opposite assertion.
|
|
253
232
|
*/
|
|
254
|
-
isNotBigInt:
|
|
233
|
+
isNotBigInt<Actual>(this: void, actual: Actual, failureMessage?: string | undefined): asserts actual is Exclude<Actual, bigint>;
|
|
255
234
|
/**
|
|
256
235
|
* Asserts that a value is _not_ a boolean.
|
|
257
236
|
*
|
|
@@ -270,7 +249,7 @@ export declare const runtimeTypeGuards: {
|
|
|
270
249
|
* @see
|
|
271
250
|
* - {@link assert.isBoolean} : the opposite assertion.
|
|
272
251
|
*/
|
|
273
|
-
isNotBoolean:
|
|
252
|
+
isNotBoolean<Actual>(this: void, actual: Actual, failureMessage?: string | undefined): asserts actual is Exclude<Actual, boolean>;
|
|
274
253
|
/**
|
|
275
254
|
* Asserts that a value is _not_ a function.
|
|
276
255
|
*
|
|
@@ -289,7 +268,7 @@ export declare const runtimeTypeGuards: {
|
|
|
289
268
|
* @see
|
|
290
269
|
* - {@link assert.isFunction} : the opposite assertion.
|
|
291
270
|
*/
|
|
292
|
-
isNotFunction:
|
|
271
|
+
isNotFunction<Actual>(this: void, actual: Actual, failureMessage?: string | undefined): asserts actual is Exclude<Actual, AnyFunction>;
|
|
293
272
|
/**
|
|
294
273
|
* Asserts that a value is _not_ exactly `null`.
|
|
295
274
|
*
|
|
@@ -308,7 +287,7 @@ export declare const runtimeTypeGuards: {
|
|
|
308
287
|
* @see
|
|
309
288
|
* - {@link assert.isFunction} : the opposite assertion.
|
|
310
289
|
*/
|
|
311
|
-
isNotNull:
|
|
290
|
+
isNotNull<Actual>(this: void, actual: Actual, failureMessage?: string | undefined): asserts actual is Exclude<Actual, null>;
|
|
312
291
|
/**
|
|
313
292
|
* Asserts that a value is _not_ a number. This includes `NaN`.
|
|
314
293
|
*
|
|
@@ -327,7 +306,7 @@ export declare const runtimeTypeGuards: {
|
|
|
327
306
|
* @see
|
|
328
307
|
* - {@link assert.isNotFunction} : the opposite assertion.
|
|
329
308
|
*/
|
|
330
|
-
isNotNumber:
|
|
309
|
+
isNotNumber<Actual>(this: void, actual: Actual, failureMessage?: string | undefined): asserts actual is Exclude<Actual, number>;
|
|
331
310
|
/**
|
|
332
311
|
* Asserts that a value is _not_ an object. This includes arrays.
|
|
333
312
|
*
|
|
@@ -346,7 +325,7 @@ export declare const runtimeTypeGuards: {
|
|
|
346
325
|
* @see
|
|
347
326
|
* - {@link assert.isFunction} : the opposite assertion.
|
|
348
327
|
*/
|
|
349
|
-
isNotObject:
|
|
328
|
+
isNotObject<Actual>(this: void, actual: Actual, failureMessage?: string | undefined): asserts actual is Exclude<Actual, UnknownObject>;
|
|
350
329
|
/**
|
|
351
330
|
* Asserts that a value is _not_ a string.
|
|
352
331
|
*
|
|
@@ -365,7 +344,7 @@ export declare const runtimeTypeGuards: {
|
|
|
365
344
|
* @see
|
|
366
345
|
* - {@link assert.isFunction} : the opposite assertion.
|
|
367
346
|
*/
|
|
368
|
-
isNotString:
|
|
347
|
+
isNotString<Actual>(this: void, actual: Actual, failureMessage?: string | undefined): asserts actual is Exclude<Actual, string>;
|
|
369
348
|
/**
|
|
370
349
|
* Asserts that a value is _not_ a symbol.
|
|
371
350
|
*
|
|
@@ -384,7 +363,7 @@ export declare const runtimeTypeGuards: {
|
|
|
384
363
|
* @see
|
|
385
364
|
* - {@link assert.isFunction} : the opposite assertion.
|
|
386
365
|
*/
|
|
387
|
-
isNotSymbol:
|
|
366
|
+
isNotSymbol<Actual>(this: void, actual: Actual, failureMessage?: string | undefined): asserts actual is Exclude<Actual, symbol>;
|
|
388
367
|
/**
|
|
389
368
|
* Asserts that a value is _not_ exactly `undefined`.
|
|
390
369
|
*
|
|
@@ -403,7 +382,7 @@ export declare const runtimeTypeGuards: {
|
|
|
403
382
|
* @see
|
|
404
383
|
* - {@link assert.isFunction} : the opposite assertion.
|
|
405
384
|
*/
|
|
406
|
-
isNotUndefined:
|
|
385
|
+
isNotUndefined<Actual>(this: void, actual: Actual, failureMessage?: string | undefined): asserts actual is Exclude<Actual, undefined>;
|
|
407
386
|
};
|
|
408
387
|
check: {
|
|
409
388
|
/**
|
|
@@ -423,7 +402,7 @@ export declare const runtimeTypeGuards: {
|
|
|
423
402
|
* @see
|
|
424
403
|
* - {@link check.isNotArray} : the opposite check.
|
|
425
404
|
*/
|
|
426
|
-
isArray
|
|
405
|
+
isArray<Actual>(this: void, actual: Actual): actual is ArrayNarrow<Actual>;
|
|
427
406
|
/**
|
|
428
407
|
* Checks that a value is a BigInt.
|
|
429
408
|
*
|
|
@@ -441,7 +420,7 @@ export declare const runtimeTypeGuards: {
|
|
|
441
420
|
* @see
|
|
442
421
|
* - {@link check.isNotBigInt} : the opposite check.
|
|
443
422
|
*/
|
|
444
|
-
isBigInt:
|
|
423
|
+
isBigInt<Actual>(this: void, actual: Actual): actual is NarrowToActual<Actual, bigint>;
|
|
445
424
|
/**
|
|
446
425
|
* Checks that a value is a boolean.
|
|
447
426
|
*
|
|
@@ -459,7 +438,7 @@ export declare const runtimeTypeGuards: {
|
|
|
459
438
|
* @see
|
|
460
439
|
* - {@link check.isNotBoolean} : the opposite check.
|
|
461
440
|
*/
|
|
462
|
-
isBoolean:
|
|
441
|
+
isBoolean<Actual>(this: void, actual: Actual): actual is NarrowToActual<Actual, boolean>;
|
|
463
442
|
/**
|
|
464
443
|
* Checks that a value is a function.
|
|
465
444
|
*
|
|
@@ -477,7 +456,7 @@ export declare const runtimeTypeGuards: {
|
|
|
477
456
|
* @see
|
|
478
457
|
* - {@link check.isNotFunction} : the opposite check.
|
|
479
458
|
*/
|
|
480
|
-
isFunction
|
|
459
|
+
isFunction<Actual>(this: void, actual: Actual): actual is NarrowToActual<Actual, AnyFunction>;
|
|
481
460
|
/**
|
|
482
461
|
* Checks that a value is exactly `null`.
|
|
483
462
|
*
|
|
@@ -495,7 +474,7 @@ export declare const runtimeTypeGuards: {
|
|
|
495
474
|
* @see
|
|
496
475
|
* - {@link check.isNotFunction} : the opposite check.
|
|
497
476
|
*/
|
|
498
|
-
isNull:
|
|
477
|
+
isNull<Actual>(this: void, actual: Actual): actual is NarrowToActual<Actual, null>;
|
|
499
478
|
/**
|
|
500
479
|
* Checks that a value is a number. This excludes `NaN`.
|
|
501
480
|
*
|
|
@@ -513,7 +492,7 @@ export declare const runtimeTypeGuards: {
|
|
|
513
492
|
* @see
|
|
514
493
|
* - {@link check.isNotFunction} : the opposite check.
|
|
515
494
|
*/
|
|
516
|
-
isNumber:
|
|
495
|
+
isNumber<Actual>(this: void, actual: Actual): actual is NarrowToActual<Actual, number>;
|
|
517
496
|
/**
|
|
518
497
|
* Checks that a value is an object. This excludes arrays.
|
|
519
498
|
*
|
|
@@ -531,7 +510,7 @@ export declare const runtimeTypeGuards: {
|
|
|
531
510
|
* @see
|
|
532
511
|
* - {@link check.isNotFunction} : the opposite check.
|
|
533
512
|
*/
|
|
534
|
-
isObject:
|
|
513
|
+
isObject<Actual>(this: void, actual: Actual): actual is NarrowToActual<Actual, UnknownObject>;
|
|
535
514
|
/**
|
|
536
515
|
* Checks that a value is a string.
|
|
537
516
|
*
|
|
@@ -549,7 +528,7 @@ export declare const runtimeTypeGuards: {
|
|
|
549
528
|
* @see
|
|
550
529
|
* - {@link check.isNotFunction} : the opposite check.
|
|
551
530
|
*/
|
|
552
|
-
isString:
|
|
531
|
+
isString<Actual>(this: void, actual: Actual): actual is NarrowToActual<Actual, string>;
|
|
553
532
|
/**
|
|
554
533
|
* Checks that a value is a symbol.
|
|
555
534
|
*
|
|
@@ -567,7 +546,7 @@ export declare const runtimeTypeGuards: {
|
|
|
567
546
|
* @see
|
|
568
547
|
* - {@link check.isNotFunction} : the opposite check.
|
|
569
548
|
*/
|
|
570
|
-
isSymbol:
|
|
549
|
+
isSymbol<Actual>(this: void, actual: Actual): actual is NarrowToActual<Actual, symbol>;
|
|
571
550
|
/**
|
|
572
551
|
* Checks that a value is exactly `undefined`.
|
|
573
552
|
*
|
|
@@ -585,7 +564,7 @@ export declare const runtimeTypeGuards: {
|
|
|
585
564
|
* @see
|
|
586
565
|
* - {@link check.isNotFunction} : the opposite check.
|
|
587
566
|
*/
|
|
588
|
-
isUndefined:
|
|
567
|
+
isUndefined<Actual>(this: void, actual: Actual): actual is NarrowToActual<Actual, undefined>;
|
|
589
568
|
/**
|
|
590
569
|
* Checks that a value is _not_ an array.
|
|
591
570
|
*
|
|
@@ -603,7 +582,7 @@ export declare const runtimeTypeGuards: {
|
|
|
603
582
|
* @see
|
|
604
583
|
* - {@link check.isArray} : the opposite check.
|
|
605
584
|
*/
|
|
606
|
-
isNotArray
|
|
585
|
+
isNotArray<Actual>(this: void, actual: Actual): actual is Exclude<Actual, ReadonlyArray<unknown>>;
|
|
607
586
|
/**
|
|
608
587
|
* Checks that a value is _not_ a BigInt.
|
|
609
588
|
*
|
|
@@ -621,7 +600,7 @@ export declare const runtimeTypeGuards: {
|
|
|
621
600
|
* @see
|
|
622
601
|
* - {@link check.isBigInt} : the opposite check.
|
|
623
602
|
*/
|
|
624
|
-
isNotBigInt
|
|
603
|
+
isNotBigInt<Actual>(this: void, actual: Actual): actual is Exclude<Actual, bigint>;
|
|
625
604
|
/**
|
|
626
605
|
* Checks that a value is _not_ a boolean.
|
|
627
606
|
*
|
|
@@ -639,7 +618,7 @@ export declare const runtimeTypeGuards: {
|
|
|
639
618
|
* @see
|
|
640
619
|
* - {@link check.isBoolean} : the opposite check.
|
|
641
620
|
*/
|
|
642
|
-
isNotBoolean
|
|
621
|
+
isNotBoolean<Actual>(this: void, actual: Actual): actual is Exclude<Actual, boolean>;
|
|
643
622
|
/**
|
|
644
623
|
* Checks that a value is _not_ a function.
|
|
645
624
|
*
|
|
@@ -657,7 +636,7 @@ export declare const runtimeTypeGuards: {
|
|
|
657
636
|
* @see
|
|
658
637
|
* - {@link check.isFunction} : the opposite check.
|
|
659
638
|
*/
|
|
660
|
-
isNotFunction
|
|
639
|
+
isNotFunction<Actual>(this: void, actual: Actual): actual is Exclude<Actual, AnyFunction>;
|
|
661
640
|
/**
|
|
662
641
|
* Checks that a value is _not_ exactly `null`.
|
|
663
642
|
*
|
|
@@ -675,7 +654,7 @@ export declare const runtimeTypeGuards: {
|
|
|
675
654
|
* @see
|
|
676
655
|
* - {@link check.isFunction} : the opposite check.
|
|
677
656
|
*/
|
|
678
|
-
isNotNull
|
|
657
|
+
isNotNull<Actual>(this: void, actual: Actual): actual is Exclude<Actual, null>;
|
|
679
658
|
/**
|
|
680
659
|
* Checks that a value is _not_ a number. This includes `NaN`.
|
|
681
660
|
*
|
|
@@ -693,7 +672,7 @@ export declare const runtimeTypeGuards: {
|
|
|
693
672
|
* @see
|
|
694
673
|
* - {@link check.isNotFunction} : the opposite check.
|
|
695
674
|
*/
|
|
696
|
-
isNotNumber
|
|
675
|
+
isNotNumber<Actual>(this: void, actual: Actual): actual is Exclude<Actual, number>;
|
|
697
676
|
/**
|
|
698
677
|
* Checks that a value is _not_ an object. This includes arrays.
|
|
699
678
|
*
|
|
@@ -711,7 +690,7 @@ export declare const runtimeTypeGuards: {
|
|
|
711
690
|
* @see
|
|
712
691
|
* - {@link check.isFunction} : the opposite check.
|
|
713
692
|
*/
|
|
714
|
-
isNotObject
|
|
693
|
+
isNotObject<Actual>(this: void, actual: Actual): actual is Exclude<Actual, UnknownObject>;
|
|
715
694
|
/**
|
|
716
695
|
* Checks that a value is _not_ a string.
|
|
717
696
|
*
|
|
@@ -729,7 +708,7 @@ export declare const runtimeTypeGuards: {
|
|
|
729
708
|
* @see
|
|
730
709
|
* - {@link check.isFunction} : the opposite check.
|
|
731
710
|
*/
|
|
732
|
-
isNotString
|
|
711
|
+
isNotString<Actual>(this: void, actual: Actual): actual is Exclude<Actual, string>;
|
|
733
712
|
/**
|
|
734
713
|
* Checks that a value is _not_ a symbol.
|
|
735
714
|
*
|
|
@@ -747,7 +726,7 @@ export declare const runtimeTypeGuards: {
|
|
|
747
726
|
* @see
|
|
748
727
|
* - {@link check.isFunction} : the opposite check.
|
|
749
728
|
*/
|
|
750
|
-
isNotSymbol
|
|
729
|
+
isNotSymbol<Actual>(this: void, actual: Actual): actual is Exclude<Actual, symbol>;
|
|
751
730
|
/**
|
|
752
731
|
* Checks that a value is _not_ exactly `undefined`.
|
|
753
732
|
*
|
|
@@ -765,7 +744,7 @@ export declare const runtimeTypeGuards: {
|
|
|
765
744
|
* @see
|
|
766
745
|
* - {@link check.isFunction} : the opposite check.
|
|
767
746
|
*/
|
|
768
|
-
isNotUndefined
|
|
747
|
+
isNotUndefined<Actual>(this: void, actual: Actual): actual is Exclude<Actual, undefined>;
|
|
769
748
|
};
|
|
770
749
|
assertWrap: {
|
|
771
750
|
/**
|
|
@@ -787,7 +766,7 @@ export declare const runtimeTypeGuards: {
|
|
|
787
766
|
* @see
|
|
788
767
|
* - {@link assertWrap.isNotArray} : the opposite assertion.
|
|
789
768
|
*/
|
|
790
|
-
isArray
|
|
769
|
+
isArray<Actual>(this: void, actual: Actual, failureMessage?: string | undefined): ArrayNarrow<Actual>;
|
|
791
770
|
/**
|
|
792
771
|
* Asserts that a value is a BigInt. Returns the value if the assertion passes.
|
|
793
772
|
*
|
|
@@ -807,7 +786,7 @@ export declare const runtimeTypeGuards: {
|
|
|
807
786
|
* @see
|
|
808
787
|
* - {@link assertWrap.isNotBigInt} : the opposite assertion.
|
|
809
788
|
*/
|
|
810
|
-
isBigInt:
|
|
789
|
+
isBigInt<Actual>(this: void, actual: Actual, failureMessage?: string | undefined): NarrowToExpected<Actual, bigint>;
|
|
811
790
|
/**
|
|
812
791
|
* Asserts that a value is a boolean. Returns the value if the assertion passes.
|
|
813
792
|
*
|
|
@@ -827,7 +806,7 @@ export declare const runtimeTypeGuards: {
|
|
|
827
806
|
* @see
|
|
828
807
|
* - {@link assertWrap.isNotBoolean} : the opposite assertion.
|
|
829
808
|
*/
|
|
830
|
-
isBoolean:
|
|
809
|
+
isBoolean<Actual>(this: void, actual: Actual, failureMessage?: string | undefined): NarrowToExpected<Actual, boolean>;
|
|
831
810
|
/**
|
|
832
811
|
* Asserts that a value is a function. Returns the value if the assertion passes.
|
|
833
812
|
*
|
|
@@ -847,7 +826,7 @@ export declare const runtimeTypeGuards: {
|
|
|
847
826
|
* @see
|
|
848
827
|
* - {@link assertWrap.isNotFunction} : the opposite assertion.
|
|
849
828
|
*/
|
|
850
|
-
isFunction
|
|
829
|
+
isFunction<Actual>(this: void, actual: Actual, failureMessage?: string | undefined): NarrowToActual<Actual, AnyFunction>;
|
|
851
830
|
/**
|
|
852
831
|
* Asserts that a value is exactly `null. Returns the value if the assertion passes.
|
|
853
832
|
*
|
|
@@ -867,7 +846,7 @@ export declare const runtimeTypeGuards: {
|
|
|
867
846
|
* @see
|
|
868
847
|
* - {@link assertWrap.isNotFunction} : the opposite assertion.
|
|
869
848
|
*/
|
|
870
|
-
isNull:
|
|
849
|
+
isNull<Actual>(this: void, actual: Actual, failureMessage?: string | undefined): NarrowToExpected<Actual, null>;
|
|
871
850
|
/**
|
|
872
851
|
* Asserts that a value is a number. This excludes `NaN. Returns the value if the assertion
|
|
873
852
|
* passes.
|
|
@@ -888,7 +867,7 @@ export declare const runtimeTypeGuards: {
|
|
|
888
867
|
* @see
|
|
889
868
|
* - {@link assertWrap.isNotFunction} : the opposite assertion.
|
|
890
869
|
*/
|
|
891
|
-
isNumber:
|
|
870
|
+
isNumber<Actual>(this: void, actual: Actual, failureMessage?: string | undefined): NarrowToExpected<Actual, number>;
|
|
892
871
|
/**
|
|
893
872
|
* Asserts that a value is an object. This excludes arrays. Returns the value if the
|
|
894
873
|
* assertion passes.
|
|
@@ -909,7 +888,7 @@ export declare const runtimeTypeGuards: {
|
|
|
909
888
|
* @see
|
|
910
889
|
* - {@link assertWrap.isNotFunction} : the opposite assertion.
|
|
911
890
|
*/
|
|
912
|
-
isObject:
|
|
891
|
+
isObject<Actual>(this: void, actual: Actual, failureMessage?: string | undefined): NarrowToExpected<Actual, UnknownObject>;
|
|
913
892
|
/**
|
|
914
893
|
* Asserts that a value is a string. Returns the value if the assertion passes.
|
|
915
894
|
*
|
|
@@ -929,7 +908,7 @@ export declare const runtimeTypeGuards: {
|
|
|
929
908
|
* @see
|
|
930
909
|
* - {@link assertWrap.isNotFunction} : the opposite assertion.
|
|
931
910
|
*/
|
|
932
|
-
isString:
|
|
911
|
+
isString<Actual>(this: void, actual: Actual, failureMessage?: string | undefined): NarrowToExpected<Actual, string>;
|
|
933
912
|
/**
|
|
934
913
|
* Trying to assign a unique symbol to another variable kills the `unique` part of the
|
|
935
914
|
* symbol. this seems to be a bug with TypeScript itself.
|
|
@@ -958,7 +937,7 @@ export declare const runtimeTypeGuards: {
|
|
|
958
937
|
* @see
|
|
959
938
|
* - {@link assertWrap.isNotFunction} : the opposite assertion.
|
|
960
939
|
*/
|
|
961
|
-
isSymbol
|
|
940
|
+
isSymbol<Actual>(this: void, actual: Actual, failureMessage?: string | undefined): NarrowToExpected<Actual, symbol>;
|
|
962
941
|
/**
|
|
963
942
|
* Asserts that a value is exactly `undefined. Returns the value if the assertion passes.
|
|
964
943
|
*
|
|
@@ -978,7 +957,7 @@ export declare const runtimeTypeGuards: {
|
|
|
978
957
|
* @see
|
|
979
958
|
* - {@link assertWrap.isNotFunction} : the opposite assertion.
|
|
980
959
|
*/
|
|
981
|
-
isUndefined:
|
|
960
|
+
isUndefined<Actual>(this: void, actual: Actual, failureMessage?: string | undefined): NarrowToExpected<Actual, undefined>;
|
|
982
961
|
/**
|
|
983
962
|
* Asserts that a value is _not_ an array. Returns the value if the assertion passes.
|
|
984
963
|
*
|
|
@@ -998,7 +977,7 @@ export declare const runtimeTypeGuards: {
|
|
|
998
977
|
* @see
|
|
999
978
|
* - {@link assertWrap.isArray} : the opposite assertion.
|
|
1000
979
|
*/
|
|
1001
|
-
isNotArray
|
|
980
|
+
isNotArray<Actual>(this: void, actual: Actual, failureMessage?: string | undefined): Exclude<Actual, ReadonlyArray<unknown>>;
|
|
1002
981
|
/**
|
|
1003
982
|
* Asserts that a value is _not_ a BigInt. Returns the value if the assertion passes.
|
|
1004
983
|
*
|
|
@@ -1018,7 +997,7 @@ export declare const runtimeTypeGuards: {
|
|
|
1018
997
|
* @see
|
|
1019
998
|
* - {@link assertWrap.isBigInt} : the opposite assertion.
|
|
1020
999
|
*/
|
|
1021
|
-
isNotBigInt
|
|
1000
|
+
isNotBigInt<Actual>(this: void, actual: Actual, failureMessage?: string | undefined): Exclude<Actual, bigint>;
|
|
1022
1001
|
/**
|
|
1023
1002
|
* Asserts that a value is _not_ a boolean. Returns the value if the assertion passes.
|
|
1024
1003
|
*
|
|
@@ -1038,7 +1017,7 @@ export declare const runtimeTypeGuards: {
|
|
|
1038
1017
|
* @see
|
|
1039
1018
|
* - {@link assertWrap.isBoolean} : the opposite assertion.
|
|
1040
1019
|
*/
|
|
1041
|
-
isNotBoolean
|
|
1020
|
+
isNotBoolean<Actual>(this: void, actual: Actual, failureMessage?: string | undefined): Exclude<Actual, boolean>;
|
|
1042
1021
|
/**
|
|
1043
1022
|
* Asserts that a value is _not_ a function. Returns the value if the assertion passes.
|
|
1044
1023
|
*
|
|
@@ -1058,7 +1037,7 @@ export declare const runtimeTypeGuards: {
|
|
|
1058
1037
|
* @see
|
|
1059
1038
|
* - {@link assertWrap.isFunction} : the opposite assertion.
|
|
1060
1039
|
*/
|
|
1061
|
-
isNotFunction
|
|
1040
|
+
isNotFunction<Actual>(this: void, actual: Actual, failureMessage?: string | undefined): Exclude<Actual, AnyFunction>;
|
|
1062
1041
|
/**
|
|
1063
1042
|
* Asserts that a value is _not_ exactly `null. Returns the value if the assertion passes.
|
|
1064
1043
|
*
|
|
@@ -1078,7 +1057,7 @@ export declare const runtimeTypeGuards: {
|
|
|
1078
1057
|
* @see
|
|
1079
1058
|
* - {@link assertWrap.isFunction} : the opposite assertion.
|
|
1080
1059
|
*/
|
|
1081
|
-
isNotNull
|
|
1060
|
+
isNotNull<Actual>(this: void, actual: Actual, failureMessage?: string | undefined): Exclude<Actual, null>;
|
|
1082
1061
|
/**
|
|
1083
1062
|
* Asserts that a value is _not_ a number. This includes `NaN. Returns the value if the
|
|
1084
1063
|
* assertion passes.
|
|
@@ -1099,7 +1078,7 @@ export declare const runtimeTypeGuards: {
|
|
|
1099
1078
|
* @see
|
|
1100
1079
|
* - {@link assertWrap.isNotFunction} : the opposite assertion.
|
|
1101
1080
|
*/
|
|
1102
|
-
isNotNumber
|
|
1081
|
+
isNotNumber<Actual>(this: void, actual: Actual, failureMessage?: string | undefined): Exclude<Actual, number>;
|
|
1103
1082
|
/**
|
|
1104
1083
|
* Asserts that a value is _not_ an object. This includes arrays. Returns the value if the
|
|
1105
1084
|
* assertion passes.
|
|
@@ -1120,7 +1099,7 @@ export declare const runtimeTypeGuards: {
|
|
|
1120
1099
|
* @see
|
|
1121
1100
|
* - {@link assertWrap.isFunction} : the opposite assertion.
|
|
1122
1101
|
*/
|
|
1123
|
-
isNotObject
|
|
1102
|
+
isNotObject<Actual>(this: void, actual: Actual, failureMessage?: string | undefined): Exclude<Actual, UnknownObject>;
|
|
1124
1103
|
/**
|
|
1125
1104
|
* Asserts that a value is _not_ a string. Returns the value if the assertion passes.
|
|
1126
1105
|
*
|
|
@@ -1140,7 +1119,7 @@ export declare const runtimeTypeGuards: {
|
|
|
1140
1119
|
* @see
|
|
1141
1120
|
* - {@link assertWrap.isFunction} : the opposite assertion.
|
|
1142
1121
|
*/
|
|
1143
|
-
isNotString
|
|
1122
|
+
isNotString<Actual>(this: void, actual: Actual, failureMessage?: string | undefined): Exclude<Actual, string>;
|
|
1144
1123
|
/**
|
|
1145
1124
|
* Asserts that a value is _not_ a symbol. Returns the value if the assertion passes.
|
|
1146
1125
|
*
|
|
@@ -1160,7 +1139,7 @@ export declare const runtimeTypeGuards: {
|
|
|
1160
1139
|
* @see
|
|
1161
1140
|
* - {@link assertWrap.isFunction} : the opposite assertion.
|
|
1162
1141
|
*/
|
|
1163
|
-
isNotSymbol
|
|
1142
|
+
isNotSymbol<Actual>(this: void, actual: Actual, failureMessage?: string | undefined): Exclude<Actual, symbol>;
|
|
1164
1143
|
/**
|
|
1165
1144
|
* Asserts that a value is _not_ exactly `undefined. Returns the value if the assertion
|
|
1166
1145
|
* passes.
|
|
@@ -1181,7 +1160,7 @@ export declare const runtimeTypeGuards: {
|
|
|
1181
1160
|
* @see
|
|
1182
1161
|
* - {@link assertWrap.isFunction} : the opposite assertion.
|
|
1183
1162
|
*/
|
|
1184
|
-
isNotUndefined
|
|
1163
|
+
isNotUndefined<Actual>(this: void, actual: Actual, failureMessage?: string | undefined): Exclude<Actual, undefined>;
|
|
1185
1164
|
};
|
|
1186
1165
|
checkWrap: {
|
|
1187
1166
|
/**
|
|
@@ -1203,7 +1182,7 @@ export declare const runtimeTypeGuards: {
|
|
|
1203
1182
|
* @see
|
|
1204
1183
|
* - {@link checkWrap.isNotArray} : the opposite check.
|
|
1205
1184
|
*/
|
|
1206
|
-
isArray
|
|
1185
|
+
isArray<Actual>(this: void, actual: Actual): ArrayNarrow<Actual> | undefined;
|
|
1207
1186
|
/**
|
|
1208
1187
|
* Checks that a value is a BigInt. Returns the value if the check passes, otherwise
|
|
1209
1188
|
* `undefined`.
|
|
@@ -1223,7 +1202,7 @@ export declare const runtimeTypeGuards: {
|
|
|
1223
1202
|
* @see
|
|
1224
1203
|
* - {@link checkWrap.isNotBigInt} : the opposite check.
|
|
1225
1204
|
*/
|
|
1226
|
-
isBigInt:
|
|
1205
|
+
isBigInt<Actual>(this: void, actual: Actual): NarrowToActual<Actual, bigint> | undefined;
|
|
1227
1206
|
/**
|
|
1228
1207
|
* Checks that a value is a boolean. Returns the value if the check passes, otherwise
|
|
1229
1208
|
* `undefined`.
|
|
@@ -1243,7 +1222,7 @@ export declare const runtimeTypeGuards: {
|
|
|
1243
1222
|
* @see
|
|
1244
1223
|
* - {@link checkWrap.isNotBoolean} : the opposite check.
|
|
1245
1224
|
*/
|
|
1246
|
-
isBoolean:
|
|
1225
|
+
isBoolean<Actual>(this: void, actual: Actual): NarrowToActual<Actual, boolean> | undefined;
|
|
1247
1226
|
/**
|
|
1248
1227
|
* Checks that a value is a function. Returns the value if the check passes, otherwise
|
|
1249
1228
|
* `undefined`.
|
|
@@ -1263,7 +1242,7 @@ export declare const runtimeTypeGuards: {
|
|
|
1263
1242
|
* @see
|
|
1264
1243
|
* - {@link checkWrap.isNotFunction} : the opposite check.
|
|
1265
1244
|
*/
|
|
1266
|
-
isFunction
|
|
1245
|
+
isFunction<Actual>(this: void, actual: Actual): NarrowToActual<Actual, AnyFunction> | undefined;
|
|
1267
1246
|
/**
|
|
1268
1247
|
* Checks that a value is exactly `null. Returns the value if the check passes, otherwise
|
|
1269
1248
|
* `undefined`.
|
|
@@ -1283,7 +1262,7 @@ export declare const runtimeTypeGuards: {
|
|
|
1283
1262
|
* @see
|
|
1284
1263
|
* - {@link checkWrap.isNotFunction} : the opposite check.
|
|
1285
1264
|
*/
|
|
1286
|
-
isNull:
|
|
1265
|
+
isNull<Actual>(this: void, actual: Actual): NarrowToActual<Actual, null> | undefined;
|
|
1287
1266
|
/**
|
|
1288
1267
|
* Checks that a value is a number. This excludes `NaN. Returns the value if the check
|
|
1289
1268
|
* passes, otherwise `undefined`.
|
|
@@ -1303,7 +1282,7 @@ export declare const runtimeTypeGuards: {
|
|
|
1303
1282
|
* @see
|
|
1304
1283
|
* - {@link checkWrap.isNotFunction} : the opposite check.
|
|
1305
1284
|
*/
|
|
1306
|
-
isNumber:
|
|
1285
|
+
isNumber<Actual>(this: void, actual: Actual): NarrowToActual<Actual, number> | undefined;
|
|
1307
1286
|
/**
|
|
1308
1287
|
* Checks that a value is an object. This excludes arrays. Returns the value if the check
|
|
1309
1288
|
* passes, otherwise `undefined`.
|
|
@@ -1323,7 +1302,7 @@ export declare const runtimeTypeGuards: {
|
|
|
1323
1302
|
* @see
|
|
1324
1303
|
* - {@link checkWrap.isNotFunction} : the opposite check.
|
|
1325
1304
|
*/
|
|
1326
|
-
isObject:
|
|
1305
|
+
isObject<Actual>(this: void, actual: Actual): NarrowToActual<Actual, UnknownObject> | undefined;
|
|
1327
1306
|
/**
|
|
1328
1307
|
* Checks that a value is a string. Returns the value if the check passes, otherwise
|
|
1329
1308
|
* `undefined`.
|
|
@@ -1343,7 +1322,7 @@ export declare const runtimeTypeGuards: {
|
|
|
1343
1322
|
* @see
|
|
1344
1323
|
* - {@link checkWrap.isNotFunction} : the opposite check.
|
|
1345
1324
|
*/
|
|
1346
|
-
isString:
|
|
1325
|
+
isString<Actual>(this: void, actual: Actual): NarrowToActual<Actual, string> | undefined;
|
|
1347
1326
|
/**
|
|
1348
1327
|
* Checks that a value is a symbol. Returns the value if the check passes, otherwise
|
|
1349
1328
|
* `undefined`.
|
|
@@ -1363,32 +1342,7 @@ export declare const runtimeTypeGuards: {
|
|
|
1363
1342
|
* @see
|
|
1364
1343
|
* - {@link checkWrap.isNotFunction} : the opposite check.
|
|
1365
1344
|
*/
|
|
1366
|
-
isSymbol:
|
|
1367
|
-
/**
|
|
1368
|
-
* It doesn't make any sense for `checkWrap.isUndefined` to exist. If the input is
|
|
1369
|
-
* `undefined`, it returns `undefined`. If the input isn't `undefined`, it still returns
|
|
1370
|
-
* `undefined`.
|
|
1371
|
-
*/
|
|
1372
|
-
/**
|
|
1373
|
-
* Checks that a value is exactly `undefined. Returns the value if the check passes,
|
|
1374
|
-
* otherwise `undefined`.
|
|
1375
|
-
*
|
|
1376
|
-
* Type guards the value.
|
|
1377
|
-
*
|
|
1378
|
-
* @example
|
|
1379
|
-
*
|
|
1380
|
-
* ```ts
|
|
1381
|
-
* import {checkWrap} from '@augment-vir/assert';
|
|
1382
|
-
*
|
|
1383
|
-
* checkWrap.isUndefined(undefined); // returns `undefined`
|
|
1384
|
-
* checkWrap.isUndefined(null); // returns `undefined`
|
|
1385
|
-
* ```
|
|
1386
|
-
*
|
|
1387
|
-
* @returns The value if the check passes. Otherwise, `undefined`.
|
|
1388
|
-
* @see
|
|
1389
|
-
* - {@link checkWrap.isNotFunction} : the opposite check.
|
|
1390
|
-
*/
|
|
1391
|
-
isUndefined: undefined;
|
|
1345
|
+
isSymbol<Actual>(this: void, actual: Actual): NarrowToActual<Actual, symbol> | undefined;
|
|
1392
1346
|
/**
|
|
1393
1347
|
* Checks that a value is _not_ an array. Returns the value if the check passes, otherwise
|
|
1394
1348
|
* `undefined`.
|
|
@@ -1408,7 +1362,7 @@ export declare const runtimeTypeGuards: {
|
|
|
1408
1362
|
* @see
|
|
1409
1363
|
* - {@link checkWrap.isArray} : the opposite check.
|
|
1410
1364
|
*/
|
|
1411
|
-
isNotArray
|
|
1365
|
+
isNotArray<Actual>(this: void, actual: Actual): Exclude<Actual, ReadonlyArray<unknown>> | undefined;
|
|
1412
1366
|
/**
|
|
1413
1367
|
* Checks that a value is _not_ a BigInt. Returns the value if the check passes, otherwise
|
|
1414
1368
|
* `undefined`.
|
|
@@ -1428,7 +1382,7 @@ export declare const runtimeTypeGuards: {
|
|
|
1428
1382
|
* @see
|
|
1429
1383
|
* - {@link checkWrap.isBigInt} : the opposite check.
|
|
1430
1384
|
*/
|
|
1431
|
-
isNotBigInt
|
|
1385
|
+
isNotBigInt<Actual>(this: void, actual: Actual): Exclude<Actual, bigint> | undefined;
|
|
1432
1386
|
/**
|
|
1433
1387
|
* Checks that a value is _not_ a boolean. Returns the value if the check passes, otherwise
|
|
1434
1388
|
* `undefined`.
|
|
@@ -1448,7 +1402,7 @@ export declare const runtimeTypeGuards: {
|
|
|
1448
1402
|
* @see
|
|
1449
1403
|
* - {@link checkWrap.isBoolean} : the opposite check.
|
|
1450
1404
|
*/
|
|
1451
|
-
isNotBoolean
|
|
1405
|
+
isNotBoolean<Actual>(this: void, actual: Actual): Exclude<Actual, boolean> | undefined;
|
|
1452
1406
|
/**
|
|
1453
1407
|
* Checks that a value is _not_ a function. Returns the value if the check passes, otherwise
|
|
1454
1408
|
* `undefined`.
|
|
@@ -1468,7 +1422,7 @@ export declare const runtimeTypeGuards: {
|
|
|
1468
1422
|
* @see
|
|
1469
1423
|
* - {@link checkWrap.isFunction} : the opposite check.
|
|
1470
1424
|
*/
|
|
1471
|
-
isNotFunction
|
|
1425
|
+
isNotFunction<Actual>(this: void, actual: Actual): Exclude<Actual, AnyFunction> | undefined;
|
|
1472
1426
|
/**
|
|
1473
1427
|
* Checks that a value is _not_ exactly `null. Returns the value if the check passes,
|
|
1474
1428
|
* otherwise `undefined`.
|
|
@@ -1488,7 +1442,7 @@ export declare const runtimeTypeGuards: {
|
|
|
1488
1442
|
* @see
|
|
1489
1443
|
* - {@link checkWrap.isFunction} : the opposite check.
|
|
1490
1444
|
*/
|
|
1491
|
-
isNotNull
|
|
1445
|
+
isNotNull<Actual>(this: void, actual: Actual): Exclude<Actual, null> | undefined;
|
|
1492
1446
|
/**
|
|
1493
1447
|
* Checks that a value is _not_ a number. This includes `NaN. Returns the value if the check
|
|
1494
1448
|
* passes, otherwise `undefined`.
|
|
@@ -1508,7 +1462,7 @@ export declare const runtimeTypeGuards: {
|
|
|
1508
1462
|
* @see
|
|
1509
1463
|
* - {@link checkWrap.isNotFunction} : the opposite check.
|
|
1510
1464
|
*/
|
|
1511
|
-
isNotNumber
|
|
1465
|
+
isNotNumber<Actual>(this: void, actual: Actual): Exclude<Actual, number> | undefined;
|
|
1512
1466
|
/**
|
|
1513
1467
|
* Checks that a value is _not_ an object. This includes arrays. Returns the value if the
|
|
1514
1468
|
* check passes, otherwise `undefined`.
|
|
@@ -1528,7 +1482,7 @@ export declare const runtimeTypeGuards: {
|
|
|
1528
1482
|
* @see
|
|
1529
1483
|
* - {@link checkWrap.isFunction} : the opposite check.
|
|
1530
1484
|
*/
|
|
1531
|
-
isNotObject
|
|
1485
|
+
isNotObject<Actual>(this: void, actual: Actual): Exclude<Actual, UnknownObject> | undefined;
|
|
1532
1486
|
/**
|
|
1533
1487
|
* Checks that a value is _not_ a string. Returns the value if the check passes, otherwise
|
|
1534
1488
|
* `undefined`.
|
|
@@ -1548,7 +1502,7 @@ export declare const runtimeTypeGuards: {
|
|
|
1548
1502
|
* @see
|
|
1549
1503
|
* - {@link checkWrap.isFunction} : the opposite check.
|
|
1550
1504
|
*/
|
|
1551
|
-
isNotString
|
|
1505
|
+
isNotString<Actual>(this: void, actual: Actual): Exclude<Actual, string> | undefined;
|
|
1552
1506
|
/**
|
|
1553
1507
|
* Checks that a value is _not_ a symbol. Returns the value if the check passes, otherwise
|
|
1554
1508
|
* `undefined`.
|
|
@@ -1568,12 +1522,7 @@ export declare const runtimeTypeGuards: {
|
|
|
1568
1522
|
* @see
|
|
1569
1523
|
* - {@link checkWrap.isFunction} : the opposite check.
|
|
1570
1524
|
*/
|
|
1571
|
-
isNotSymbol
|
|
1572
|
-
/**
|
|
1573
|
-
* It doesn't make any sense for `checkWrap.isNotUndefined` to exist. If the input is not
|
|
1574
|
-
* `undefined`, then it still returns `undefined`.
|
|
1575
|
-
*/
|
|
1576
|
-
isNotUndefined: undefined;
|
|
1525
|
+
isNotSymbol<Actual>(this: void, actual: Actual): Exclude<Actual, symbol> | undefined;
|
|
1577
1526
|
};
|
|
1578
1527
|
waitUntil: {
|
|
1579
1528
|
/**
|
|
@@ -1597,7 +1546,7 @@ export declare const runtimeTypeGuards: {
|
|
|
1597
1546
|
* @see
|
|
1598
1547
|
* - {@link waitUntil.isNotArray} : the opposite assertion.
|
|
1599
1548
|
*/
|
|
1600
|
-
isArray: <
|
|
1549
|
+
isArray: <Actual>(this: void, callback: () => MaybePromise<Actual>, options?: WaitUntilOptions | undefined, failureMessage?: string | undefined) => Promise<ArrayNarrow<Actual>>;
|
|
1601
1550
|
/**
|
|
1602
1551
|
* Repeatedly calls a callback until its output is a BigInt. Once the callback output
|
|
1603
1552
|
* passes, it is returned. If the attempts time out, an error is thrown.
|
|
@@ -1617,7 +1566,7 @@ export declare const runtimeTypeGuards: {
|
|
|
1617
1566
|
* @see
|
|
1618
1567
|
* - {@link waitUntil.isNotBigInt} : the opposite assertion.
|
|
1619
1568
|
*/
|
|
1620
|
-
isBigInt:
|
|
1569
|
+
isBigInt: <Actual>(this: void, callback: () => MaybePromise<Actual>, options?: WaitUntilOptions | undefined, failureMessage?: string | undefined) => Promise<NarrowToExpected<Actual, bigint>>;
|
|
1621
1570
|
/**
|
|
1622
1571
|
* Repeatedly calls a callback until its output is a boolean. Once the callback output
|
|
1623
1572
|
* passes, it is returned. If the attempts time out, an error is thrown.
|
|
@@ -1637,7 +1586,7 @@ export declare const runtimeTypeGuards: {
|
|
|
1637
1586
|
* @see
|
|
1638
1587
|
* - {@link waitUntil.isNotBoolean} : the opposite assertion.
|
|
1639
1588
|
*/
|
|
1640
|
-
isBoolean:
|
|
1589
|
+
isBoolean: <Actual>(this: void, callback: () => MaybePromise<Actual>, options?: WaitUntilOptions | undefined, failureMessage?: string | undefined) => Promise<NarrowToExpected<Actual, boolean>>;
|
|
1641
1590
|
/**
|
|
1642
1591
|
* Repeatedly calls a callback until its output is a function. Once the callback output
|
|
1643
1592
|
* passes, it is returned. If the attempts time out, an error is thrown.
|
|
@@ -1661,7 +1610,7 @@ export declare const runtimeTypeGuards: {
|
|
|
1661
1610
|
* @see
|
|
1662
1611
|
* - {@link waitUntil.isNotFunction} : the opposite assertion.
|
|
1663
1612
|
*/
|
|
1664
|
-
isFunction: <
|
|
1613
|
+
isFunction: <Actual>(this: void, callback: () => MaybePromise<Actual>, options?: WaitUntilOptions | undefined, failureMessage?: string | undefined) => Promise<NarrowToActual<Actual, AnyFunction>>;
|
|
1665
1614
|
/**
|
|
1666
1615
|
* Repeatedly calls a callback until its output is exactly `null`. Once the callback output
|
|
1667
1616
|
* passes, it is returned. If the attempts time out, an error is thrown.
|
|
@@ -1681,7 +1630,7 @@ export declare const runtimeTypeGuards: {
|
|
|
1681
1630
|
* @see
|
|
1682
1631
|
* - {@link waitUntil.isNotFunction} : the opposite assertion.
|
|
1683
1632
|
*/
|
|
1684
|
-
isNull:
|
|
1633
|
+
isNull: <Actual>(this: void, callback: () => MaybePromise<Actual>, options?: WaitUntilOptions | undefined, failureMessage?: string | undefined) => Promise<NarrowToExpected<Actual, null>>;
|
|
1685
1634
|
/**
|
|
1686
1635
|
* Repeatedly calls a callback until its output is a number. This excludes `NaN`. Once the
|
|
1687
1636
|
* callback output passes, it is returned. If the attempts time out, an error is thrown.
|
|
@@ -1701,7 +1650,7 @@ export declare const runtimeTypeGuards: {
|
|
|
1701
1650
|
* @see
|
|
1702
1651
|
* - {@link waitUntil.isNotFunction} : the opposite assertion.
|
|
1703
1652
|
*/
|
|
1704
|
-
isNumber:
|
|
1653
|
+
isNumber: <Actual>(this: void, callback: () => MaybePromise<Actual>, options?: WaitUntilOptions | undefined, failureMessage?: string | undefined) => Promise<NarrowToExpected<Actual, number>>;
|
|
1705
1654
|
/**
|
|
1706
1655
|
* Repeatedly calls a callback until its output is an object. This excludes arrays. Once the
|
|
1707
1656
|
* callback output passes, it is returned. If the attempts time out, an error is thrown.
|
|
@@ -1723,7 +1672,7 @@ export declare const runtimeTypeGuards: {
|
|
|
1723
1672
|
* @see
|
|
1724
1673
|
* - {@link waitUntil.isNotFunction} : the opposite assertion.
|
|
1725
1674
|
*/
|
|
1726
|
-
isObject:
|
|
1675
|
+
isObject: <Actual>(this: void, callback: () => MaybePromise<Actual>, options?: WaitUntilOptions | undefined, failureMessage?: string | undefined) => Promise<NarrowToExpected<Actual, UnknownObject>>;
|
|
1727
1676
|
/**
|
|
1728
1677
|
* Repeatedly calls a callback until its output is a string. Once the callback output
|
|
1729
1678
|
* passes, it is returned. If the attempts time out, an error is thrown.
|
|
@@ -1743,7 +1692,7 @@ export declare const runtimeTypeGuards: {
|
|
|
1743
1692
|
* @see
|
|
1744
1693
|
* - {@link waitUntil.isNotFunction} : the opposite assertion.
|
|
1745
1694
|
*/
|
|
1746
|
-
isString:
|
|
1695
|
+
isString: <Actual>(this: void, callback: () => MaybePromise<Actual>, options?: WaitUntilOptions | undefined, failureMessage?: string | undefined) => Promise<NarrowToExpected<Actual, string>>;
|
|
1747
1696
|
/**
|
|
1748
1697
|
* Repeatedly calls a callback until its output is a symbol. Once the callback output
|
|
1749
1698
|
* passes, it is returned. If the attempts time out, an error is thrown.
|
|
@@ -1763,7 +1712,7 @@ export declare const runtimeTypeGuards: {
|
|
|
1763
1712
|
* @see
|
|
1764
1713
|
* - {@link waitUntil.isNotFunction} : the opposite assertion.
|
|
1765
1714
|
*/
|
|
1766
|
-
isSymbol:
|
|
1715
|
+
isSymbol: <Actual>(this: void, callback: () => MaybePromise<Actual>, options?: WaitUntilOptions | undefined, failureMessage?: string | undefined) => Promise<NarrowToExpected<Actual, symbol>>;
|
|
1767
1716
|
/**
|
|
1768
1717
|
* Repeatedly calls a callback until its output is exactly `undefined`. Once the callback
|
|
1769
1718
|
* output passes, it is returned. If the attempts time out, an error is thrown.
|
|
@@ -1783,7 +1732,7 @@ export declare const runtimeTypeGuards: {
|
|
|
1783
1732
|
* @see
|
|
1784
1733
|
* - {@link waitUntil.isNotFunction} : the opposite assertion.
|
|
1785
1734
|
*/
|
|
1786
|
-
isUndefined:
|
|
1735
|
+
isUndefined: <Actual>(this: void, callback: () => MaybePromise<Actual>, options?: WaitUntilOptions | undefined, failureMessage?: string | undefined) => Promise<NarrowToExpected<Actual, undefined>>;
|
|
1787
1736
|
/**
|
|
1788
1737
|
* Repeatedly calls a callback until its output is _not_ an array. Once the callback output
|
|
1789
1738
|
* passes, it is returned. If the attempts time out, an error is thrown.
|
|
@@ -1805,7 +1754,7 @@ export declare const runtimeTypeGuards: {
|
|
|
1805
1754
|
* @see
|
|
1806
1755
|
* - {@link waitUntil.isArray} : the opposite assertion.
|
|
1807
1756
|
*/
|
|
1808
|
-
isNotArray: <
|
|
1757
|
+
isNotArray: <Actual>(this: void, callback: () => MaybePromise<Actual>, options?: WaitUntilOptions | undefined, failureMessage?: string | undefined) => Promise<Exclude<Actual, ReadonlyArray<unknown>>>;
|
|
1809
1758
|
/**
|
|
1810
1759
|
* Repeatedly calls a callback until its output is _not_ a BigInt. Once the callback output
|
|
1811
1760
|
* passes, it is returned. If the attempts time out, an error is thrown.
|
|
@@ -1825,7 +1774,7 @@ export declare const runtimeTypeGuards: {
|
|
|
1825
1774
|
* @see
|
|
1826
1775
|
* - {@link waitUntil.isBigInt} : the opposite assertion.
|
|
1827
1776
|
*/
|
|
1828
|
-
isNotBigInt: <
|
|
1777
|
+
isNotBigInt: <Actual>(this: void, callback: () => MaybePromise<Actual>, options?: WaitUntilOptions | undefined, failureMessage?: string | undefined) => Promise<Exclude<Actual, bigint>>;
|
|
1829
1778
|
/**
|
|
1830
1779
|
* Repeatedly calls a callback until its output is _not_ a boolean. Once the callback output
|
|
1831
1780
|
* passes, it is returned. If the attempts time out, an error is thrown.
|
|
@@ -1845,7 +1794,7 @@ export declare const runtimeTypeGuards: {
|
|
|
1845
1794
|
* @see
|
|
1846
1795
|
* - {@link waitUntil.isBoolean} : the opposite assertion.
|
|
1847
1796
|
*/
|
|
1848
|
-
isNotBoolean: <
|
|
1797
|
+
isNotBoolean: <Actual>(this: void, callback: () => MaybePromise<Actual>, options?: WaitUntilOptions | undefined, failureMessage?: string | undefined) => Promise<Exclude<Actual, boolean>>;
|
|
1849
1798
|
/**
|
|
1850
1799
|
* Repeatedly calls a callback until its output is _not_ a function. Once the callback
|
|
1851
1800
|
* output passes, it is returned. If the attempts time out, an error is thrown.
|
|
@@ -1869,7 +1818,7 @@ export declare const runtimeTypeGuards: {
|
|
|
1869
1818
|
* @see
|
|
1870
1819
|
* - {@link waitUntil.isFunction} : the opposite assertion.
|
|
1871
1820
|
*/
|
|
1872
|
-
isNotFunction: <
|
|
1821
|
+
isNotFunction: <Actual>(this: void, callback: () => MaybePromise<Actual>, options?: WaitUntilOptions | undefined, failureMessage?: string | undefined) => Promise<Exclude<Actual, AnyFunction>>;
|
|
1873
1822
|
/**
|
|
1874
1823
|
* Repeatedly calls a callback until its output is _not_ exactly `null`. Once the callback
|
|
1875
1824
|
* output passes, it is returned. If the attempts time out, an error is thrown.
|
|
@@ -1889,7 +1838,7 @@ export declare const runtimeTypeGuards: {
|
|
|
1889
1838
|
* @see
|
|
1890
1839
|
* - {@link waitUntil.isFunction} : the opposite assertion.
|
|
1891
1840
|
*/
|
|
1892
|
-
isNotNull: <
|
|
1841
|
+
isNotNull: <Actual>(this: void, callback: () => MaybePromise<Actual>, options?: WaitUntilOptions | undefined, failureMessage?: string | undefined) => Promise<Exclude<Actual, null>>;
|
|
1893
1842
|
/**
|
|
1894
1843
|
* Repeatedly calls a callback until its output is _not_ a number. This includes `NaN`. Once
|
|
1895
1844
|
* the callback output passes, it is returned. If the attempts time out, an error is
|
|
@@ -1910,7 +1859,7 @@ export declare const runtimeTypeGuards: {
|
|
|
1910
1859
|
* @see
|
|
1911
1860
|
* - {@link waitUntil.isNotFunction} : the opposite assertion.
|
|
1912
1861
|
*/
|
|
1913
|
-
isNotNumber: <
|
|
1862
|
+
isNotNumber: <Actual>(this: void, callback: () => MaybePromise<Actual>, options?: WaitUntilOptions | undefined, failureMessage?: string | undefined) => Promise<Exclude<Actual, number>>;
|
|
1914
1863
|
/**
|
|
1915
1864
|
* Repeatedly calls a callback until its output is _not_ an object. This includes arrays.
|
|
1916
1865
|
* Once the callback output passes, it is returned. If the attempts time out, an error is
|
|
@@ -1933,7 +1882,7 @@ export declare const runtimeTypeGuards: {
|
|
|
1933
1882
|
* @see
|
|
1934
1883
|
* - {@link waitUntil.isFunction} : the opposite assertion.
|
|
1935
1884
|
*/
|
|
1936
|
-
isNotObject: <
|
|
1885
|
+
isNotObject: <Actual>(this: void, callback: () => MaybePromise<Actual>, options?: WaitUntilOptions | undefined, failureMessage?: string | undefined) => Promise<Exclude<Actual, UnknownObject>>;
|
|
1937
1886
|
/**
|
|
1938
1887
|
* Repeatedly calls a callback until its output is _not_ a string. Once the callback output
|
|
1939
1888
|
* passes, it is returned. If the attempts time out, an error is thrown.
|
|
@@ -1953,7 +1902,7 @@ export declare const runtimeTypeGuards: {
|
|
|
1953
1902
|
* @see
|
|
1954
1903
|
* - {@link waitUntil.isFunction} : the opposite assertion.
|
|
1955
1904
|
*/
|
|
1956
|
-
isNotString: <
|
|
1905
|
+
isNotString: <Actual>(this: void, callback: () => MaybePromise<Actual>, options?: WaitUntilOptions | undefined, failureMessage?: string | undefined) => Promise<Exclude<Actual, string>>;
|
|
1957
1906
|
/**
|
|
1958
1907
|
* Repeatedly calls a callback until its output is _not_ a symbol. Once the callback output
|
|
1959
1908
|
* passes, it is returned. If the attempts time out, an error is thrown.
|
|
@@ -1973,7 +1922,7 @@ export declare const runtimeTypeGuards: {
|
|
|
1973
1922
|
* @see
|
|
1974
1923
|
* - {@link waitUntil.isFunction} : the opposite assertion.
|
|
1975
1924
|
*/
|
|
1976
|
-
isNotSymbol: <
|
|
1925
|
+
isNotSymbol: <Actual>(this: void, callback: () => MaybePromise<Actual>, options?: WaitUntilOptions | undefined, failureMessage?: string | undefined) => Promise<Exclude<Actual, symbol>>;
|
|
1977
1926
|
/**
|
|
1978
1927
|
* Repeatedly calls a callback until its output is _not_ exactly `undefined`. Once the
|
|
1979
1928
|
* callback output passes, it is returned. If the attempts time out, an error is thrown.
|
|
@@ -1993,7 +1942,7 @@ export declare const runtimeTypeGuards: {
|
|
|
1993
1942
|
* @see
|
|
1994
1943
|
* - {@link waitUntil.isFunction} : the opposite assertion.
|
|
1995
1944
|
*/
|
|
1996
|
-
isNotUndefined: <
|
|
1945
|
+
isNotUndefined: <Actual>(this: void, callback: () => MaybePromise<Actual>, options?: WaitUntilOptions | undefined, failureMessage?: string | undefined) => Promise<Exclude<Actual, undefined>>;
|
|
1997
1946
|
};
|
|
1998
1947
|
};
|
|
1999
1948
|
export {};
|