@augment-vir/assert 31.9.1 → 31.9.2

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.
Files changed (12) hide show
  1. package/dist/assertions/boundary.d.ts +256 -40
  2. package/dist/assertions/boundary.js +256 -40
  3. package/dist/assertions/equality/entry-equality.js +32 -8
  4. package/dist/assertions/keys.d.ts +100 -28
  5. package/dist/assertions/keys.js +100 -28
  6. package/dist/assertions/length.d.ts +212 -30
  7. package/dist/assertions/length.js +212 -30
  8. package/dist/assertions/output.js +7 -1
  9. package/dist/assertions/values.d.ts +160 -40
  10. package/dist/assertions/values.js +160 -40
  11. package/dist/augments/guards/wait-until.js +4 -1
  12. package/package.json +7 -7
package/dist/assertions/values.d.ts CHANGED
@@ -84,9 +84,21 @@ export declare const valueGuards: {
84
84
  * const child = {a: 'a'};
85
85
  * const child2 = {b: 'b'};
86
86
  *
87
- * assert.hasValues({child, child2}, [child, child2]); // passes
88
- * assert.hasValues({child: {a: 'a'}, child2}, [child, child2]); // fails
89
- * assert.hasValues([child], [child, child2]); // passes
87
+ * assert.hasValues({child, child2}, [
88
+ * child,
89
+ * child2,
90
+ * ]); // passes
91
+ * assert.hasValues({child: {a: 'a'}, child2}, [
92
+ * child,
93
+ * child2,
94
+ * ]); // fails
95
+ * assert.hasValues(
96
+ * [child],
97
+ * [
98
+ * child,
99
+ * child2,
100
+ * ],
101
+ * ); // passes
90
102
  * ```
91
103
  *
92
104
  * @throws {@link AssertionError} If the assertion fails.
@@ -109,9 +121,18 @@ export declare const valueGuards: {
109
121
  * const child = {a: 'a'};
110
122
  * const child2 = {b: 'b'};
111
123
  *
112
- * assert.lacksValues({}, [child, child2]); // passes
113
- * assert.lacksValues({child, child2}, [child, child2]); // fails
114
- * assert.lacksValues({child: {a: 'a'}, child2}, [child, child2]); // fails
124
+ * assert.lacksValues({}, [
125
+ * child,
126
+ * child2,
127
+ * ]); // passes
128
+ * assert.lacksValues({child, child2}, [
129
+ * child,
130
+ * child2,
131
+ * ]); // fails
132
+ * assert.lacksValues({child: {a: 'a'}, child2}, [
133
+ * child,
134
+ * child2,
135
+ * ]); // fails
115
136
  * ```
116
137
  *
117
138
  * @throws {@link AssertionError} If the assertion fails.
@@ -278,9 +299,21 @@ export declare const valueGuards: {
278
299
  * const child = {a: 'a'};
279
300
  * const child2 = {b: 'b'};
280
301
  *
281
- * check.hasValues({child, child2}, [child, child2]); // returns `true`
282
- * check.hasValues({child: {a: 'a'}, child2}, [child, child2]); // returns `false`
283
- * check.hasValues([child], [child, child2]); // returns `true`
302
+ * check.hasValues({child, child2}, [
303
+ * child,
304
+ * child2,
305
+ * ]); // returns `true`
306
+ * check.hasValues({child: {a: 'a'}, child2}, [
307
+ * child,
308
+ * child2,
309
+ * ]); // returns `false`
310
+ * check.hasValues(
311
+ * [child],
312
+ * [
313
+ * child,
314
+ * child2,
315
+ * ],
316
+ * ); // returns `true`
284
317
  * ```
285
318
  *
286
319
  * @see
@@ -302,9 +335,18 @@ export declare const valueGuards: {
302
335
  * const child = {a: 'a'};
303
336
  * const child2 = {b: 'b'};
304
337
  *
305
- * check.lacksValues({}, [child, child2]); // returns `true`
306
- * check.lacksValues({child, child2}, [child, child2]); // returns `false`
307
- * check.lacksValues({child: {a: 'a'}, child2}, [child, child2]); // returns `false`
338
+ * check.lacksValues({}, [
339
+ * child,
340
+ * child2,
341
+ * ]); // returns `true`
342
+ * check.lacksValues({child, child2}, [
343
+ * child,
344
+ * child2,
345
+ * ]); // returns `false`
346
+ * check.lacksValues({child: {a: 'a'}, child2}, [
347
+ * child,
348
+ * child2,
349
+ * ]); // returns `false`
308
350
  * ```
309
351
  *
310
352
  * @see
@@ -472,9 +514,21 @@ export declare const valueGuards: {
472
514
  * const child = {a: 'a'};
473
515
  * const child2 = {b: 'b'};
474
516
  *
475
- * assertWrap.hasValues({child, child2}, [child, child2]); // returns `{child, child2}`;
476
- * assertWrap.hasValues({child: {a: 'a'}, child2}, [child, child2]); // throws an error
477
- * assertWrap.hasValues([child], [child, child2]); // returns `[child]`;
517
+ * assertWrap.hasValues({child, child2}, [
518
+ * child,
519
+ * child2,
520
+ * ]); // returns `{child, child2}`;
521
+ * assertWrap.hasValues({child: {a: 'a'}, child2}, [
522
+ * child,
523
+ * child2,
524
+ * ]); // throws an error
525
+ * assertWrap.hasValues(
526
+ * [child],
527
+ * [
528
+ * child,
529
+ * child2,
530
+ * ],
531
+ * ); // returns `[child]`;
478
532
  * ```
479
533
  *
480
534
  * @returns The value if the assertion passes.
@@ -498,9 +552,18 @@ export declare const valueGuards: {
498
552
  * const child = {a: 'a'};
499
553
  * const child2 = {b: 'b'};
500
554
  *
501
- * assertWrap.lacksValues({}, [child, child2]); // returns `{}`;
502
- * assertWrap.lacksValues({child, child2}, [child, child2]); // throws an error
503
- * assertWrap.lacksValues({child: {a: 'a'}, child2}, [child, child2]); // throws an error
555
+ * assertWrap.lacksValues({}, [
556
+ * child,
557
+ * child2,
558
+ * ]); // returns `{}`;
559
+ * assertWrap.lacksValues({child, child2}, [
560
+ * child,
561
+ * child2,
562
+ * ]); // throws an error
563
+ * assertWrap.lacksValues({child: {a: 'a'}, child2}, [
564
+ * child,
565
+ * child2,
566
+ * ]); // throws an error
504
567
  * ```
505
568
  *
506
569
  * @returns The value if the assertion passes.
@@ -674,9 +737,21 @@ export declare const valueGuards: {
674
737
  * const child = {a: 'a'};
675
738
  * const child2 = {b: 'b'};
676
739
  *
677
- * checkWrap.hasValues({child, child2}, [child, child2]); // returns `{child, child2}`
678
- * checkWrap.hasValues({child: {a: 'a'}, child2}, [child, child2]); // returns `undefined`
679
- * checkWrap.hasValues([child], [child, child2]); // returns `[child]`
740
+ * checkWrap.hasValues({child, child2}, [
741
+ * child,
742
+ * child2,
743
+ * ]); // returns `{child, child2}`
744
+ * checkWrap.hasValues({child: {a: 'a'}, child2}, [
745
+ * child,
746
+ * child2,
747
+ * ]); // returns `undefined`
748
+ * checkWrap.hasValues(
749
+ * [child],
750
+ * [
751
+ * child,
752
+ * child2,
753
+ * ],
754
+ * ); // returns `[child]`
680
755
  * ```
681
756
  *
682
757
  * @see
@@ -698,9 +773,18 @@ export declare const valueGuards: {
698
773
  * const child = {a: 'a'};
699
774
  * const child2 = {b: 'b'};
700
775
  *
701
- * checkWrap.lacksValues({}, [child, child2]); // returns `{}`
702
- * checkWrap.lacksValues({child, child2}, [child, child2]); // returns `undefined`
703
- * checkWrap.lacksValues({child: {a: 'a'}, child2}, [child, child2]); // returns `undefined`
776
+ * checkWrap.lacksValues({}, [
777
+ * child,
778
+ * child2,
779
+ * ]); // returns `{}`
780
+ * checkWrap.lacksValues({child, child2}, [
781
+ * child,
782
+ * child2,
783
+ * ]); // returns `undefined`
784
+ * checkWrap.lacksValues({child: {a: 'a'}, child2}, [
785
+ * child,
786
+ * child2,
787
+ * ]); // returns `undefined`
704
788
  * ```
705
789
  *
706
790
  * @see
@@ -879,13 +963,31 @@ export declare const valueGuards: {
879
963
  * const child = {a: 'a'};
880
964
  * const child2 = {b: 'b'};
881
965
  *
882
- * await waitUntil.hasValues([child, child2], () => {
883
- * return {child, child2};
884
- * }); // returns `{child, child2}`;
885
- * await waitUntil.hasValues([child, child2], () => {
886
- * return {child: {a: 'a'}, child2};
887
- * }); // throws an error
888
- * await waitUntil.hasValues([child, child2], () => [child]); // returns `[child]`;
966
+ * await waitUntil.hasValues(
967
+ * [
968
+ * child,
969
+ * child2,
970
+ * ],
971
+ * () => {
972
+ * return {child, child2};
973
+ * },
974
+ * ); // returns `{child, child2}`;
975
+ * await waitUntil.hasValues(
976
+ * [
977
+ * child,
978
+ * child2,
979
+ * ],
980
+ * () => {
981
+ * return {child: {a: 'a'}, child2};
982
+ * },
983
+ * ); // throws an error
984
+ * await waitUntil.hasValues(
985
+ * [
986
+ * child,
987
+ * child2,
988
+ * ],
989
+ * () => [child],
990
+ * ); // returns `[child]`;
889
991
  * ```
890
992
  *
891
993
  * @returns The callback output once it passes.
@@ -910,15 +1012,33 @@ export declare const valueGuards: {
910
1012
  * const child = {a: 'a'};
911
1013
  * const child2 = {b: 'b'};
912
1014
  *
913
- * await waitUntil.lacksValues([child, child2], () => {
914
- * return {};
915
- * }); // returns `{}`;
916
- * await waitUntil.lacksValues([child, child2], () => {
917
- * return {child, child2};
918
- * }); // throws an error
919
- * await waitUntil.lacksValues([child, child2], () => {
920
- * return {child: {a: 'a'}, child2};
921
- * }); // throws an error
1015
+ * await waitUntil.lacksValues(
1016
+ * [
1017
+ * child,
1018
+ * child2,
1019
+ * ],
1020
+ * () => {
1021
+ * return {};
1022
+ * },
1023
+ * ); // returns `{}`;
1024
+ * await waitUntil.lacksValues(
1025
+ * [
1026
+ * child,
1027
+ * child2,
1028
+ * ],
1029
+ * () => {
1030
+ * return {child, child2};
1031
+ * },
1032
+ * ); // throws an error
1033
+ * await waitUntil.lacksValues(
1034
+ * [
1035
+ * child,
1036
+ * child2,
1037
+ * ],
1038
+ * () => {
1039
+ * return {child: {a: 'a'}, child2};
1040
+ * },
1041
+ * ); // throws an error
922
1042
  * ```
923
1043
  *
924
1044
  * @returns The callback output once it passes.
package/dist/assertions/values.js CHANGED
@@ -94,9 +94,21 @@ const assertions = {
94
94
  * const child = {a: 'a'};
95
95
  * const child2 = {b: 'b'};
96
96
  *
97
- * assert.hasValues({child, child2}, [child, child2]); // passes
98
- * assert.hasValues({child: {a: 'a'}, child2}, [child, child2]); // fails
99
- * assert.hasValues([child], [child, child2]); // passes
97
+ * assert.hasValues({child, child2}, [
98
+ * child,
99
+ * child2,
100
+ * ]); // passes
101
+ * assert.hasValues({child: {a: 'a'}, child2}, [
102
+ * child,
103
+ * child2,
104
+ * ]); // fails
105
+ * assert.hasValues(
106
+ * [child],
107
+ * [
108
+ * child,
109
+ * child2,
110
+ * ],
111
+ * ); // passes
100
112
  * ```
101
113
  *
102
114
  * @throws {@link AssertionError} If the assertion fails.
@@ -140,9 +152,18 @@ const assertions = {
140
152
  * const child = {a: 'a'};
141
153
  * const child2 = {b: 'b'};
142
154
  *
143
- * assert.lacksValues({}, [child, child2]); // passes
144
- * assert.lacksValues({child, child2}, [child, child2]); // fails
145
- * assert.lacksValues({child: {a: 'a'}, child2}, [child, child2]); // fails
155
+ * assert.lacksValues({}, [
156
+ * child,
157
+ * child2,
158
+ * ]); // passes
159
+ * assert.lacksValues({child, child2}, [
160
+ * child,
161
+ * child2,
162
+ * ]); // fails
163
+ * assert.lacksValues({child: {a: 'a'}, child2}, [
164
+ * child,
165
+ * child2,
166
+ * ]); // fails
146
167
  * ```
147
168
  *
148
169
  * @throws {@link AssertionError} If the assertion fails.
@@ -391,9 +412,21 @@ export const valueGuards = {
391
412
  * const child = {a: 'a'};
392
413
  * const child2 = {b: 'b'};
393
414
  *
394
- * check.hasValues({child, child2}, [child, child2]); // returns `true`
395
- * check.hasValues({child: {a: 'a'}, child2}, [child, child2]); // returns `false`
396
- * check.hasValues([child], [child, child2]); // returns `true`
415
+ * check.hasValues({child, child2}, [
416
+ * child,
417
+ * child2,
418
+ * ]); // returns `true`
419
+ * check.hasValues({child: {a: 'a'}, child2}, [
420
+ * child,
421
+ * child2,
422
+ * ]); // returns `false`
423
+ * check.hasValues(
424
+ * [child],
425
+ * [
426
+ * child,
427
+ * child2,
428
+ * ],
429
+ * ); // returns `true`
397
430
  * ```
398
431
  *
399
432
  * @see
@@ -417,9 +450,18 @@ export const valueGuards = {
417
450
  * const child = {a: 'a'};
418
451
  * const child2 = {b: 'b'};
419
452
  *
420
- * check.lacksValues({}, [child, child2]); // returns `true`
421
- * check.lacksValues({child, child2}, [child, child2]); // returns `false`
422
- * check.lacksValues({child: {a: 'a'}, child2}, [child, child2]); // returns `false`
453
+ * check.lacksValues({}, [
454
+ * child,
455
+ * child2,
456
+ * ]); // returns `true`
457
+ * check.lacksValues({child, child2}, [
458
+ * child,
459
+ * child2,
460
+ * ]); // returns `false`
461
+ * check.lacksValues({child: {a: 'a'}, child2}, [
462
+ * child,
463
+ * child2,
464
+ * ]); // returns `false`
423
465
  * ```
424
466
  *
425
467
  * @see
@@ -641,9 +683,21 @@ export const valueGuards = {
641
683
  * const child = {a: 'a'};
642
684
  * const child2 = {b: 'b'};
643
685
  *
644
- * assertWrap.hasValues({child, child2}, [child, child2]); // returns `{child, child2}`;
645
- * assertWrap.hasValues({child: {a: 'a'}, child2}, [child, child2]); // throws an error
646
- * assertWrap.hasValues([child], [child, child2]); // returns `[child]`;
686
+ * assertWrap.hasValues({child, child2}, [
687
+ * child,
688
+ * child2,
689
+ * ]); // returns `{child, child2}`;
690
+ * assertWrap.hasValues({child: {a: 'a'}, child2}, [
691
+ * child,
692
+ * child2,
693
+ * ]); // throws an error
694
+ * assertWrap.hasValues(
695
+ * [child],
696
+ * [
697
+ * child,
698
+ * child2,
699
+ * ],
700
+ * ); // returns `[child]`;
647
701
  * ```
648
702
  *
649
703
  * @returns The value if the assertion passes.
@@ -689,9 +743,18 @@ export const valueGuards = {
689
743
  * const child = {a: 'a'};
690
744
  * const child2 = {b: 'b'};
691
745
  *
692
- * assertWrap.lacksValues({}, [child, child2]); // returns `{}`;
693
- * assertWrap.lacksValues({child, child2}, [child, child2]); // throws an error
694
- * assertWrap.lacksValues({child: {a: 'a'}, child2}, [child, child2]); // throws an error
746
+ * assertWrap.lacksValues({}, [
747
+ * child,
748
+ * child2,
749
+ * ]); // returns `{}`;
750
+ * assertWrap.lacksValues({child, child2}, [
751
+ * child,
752
+ * child2,
753
+ * ]); // throws an error
754
+ * assertWrap.lacksValues({child: {a: 'a'}, child2}, [
755
+ * child,
756
+ * child2,
757
+ * ]); // throws an error
695
758
  * ```
696
759
  *
697
760
  * @returns The value if the assertion passes.
@@ -959,9 +1022,21 @@ export const valueGuards = {
959
1022
  * const child = {a: 'a'};
960
1023
  * const child2 = {b: 'b'};
961
1024
  *
962
- * checkWrap.hasValues({child, child2}, [child, child2]); // returns `{child, child2}`
963
- * checkWrap.hasValues({child: {a: 'a'}, child2}, [child, child2]); // returns `undefined`
964
- * checkWrap.hasValues([child], [child, child2]); // returns `[child]`
1025
+ * checkWrap.hasValues({child, child2}, [
1026
+ * child,
1027
+ * child2,
1028
+ * ]); // returns `{child, child2}`
1029
+ * checkWrap.hasValues({child: {a: 'a'}, child2}, [
1030
+ * child,
1031
+ * child2,
1032
+ * ]); // returns `undefined`
1033
+ * checkWrap.hasValues(
1034
+ * [child],
1035
+ * [
1036
+ * child,
1037
+ * child2,
1038
+ * ],
1039
+ * ); // returns `[child]`
965
1040
  * ```
966
1041
  *
967
1042
  * @see
@@ -990,9 +1065,18 @@ export const valueGuards = {
990
1065
  * const child = {a: 'a'};
991
1066
  * const child2 = {b: 'b'};
992
1067
  *
993
- * checkWrap.lacksValues({}, [child, child2]); // returns `{}`
994
- * checkWrap.lacksValues({child, child2}, [child, child2]); // returns `undefined`
995
- * checkWrap.lacksValues({child: {a: 'a'}, child2}, [child, child2]); // returns `undefined`
1068
+ * checkWrap.lacksValues({}, [
1069
+ * child,
1070
+ * child2,
1071
+ * ]); // returns `{}`
1072
+ * checkWrap.lacksValues({child, child2}, [
1073
+ * child,
1074
+ * child2,
1075
+ * ]); // returns `undefined`
1076
+ * checkWrap.lacksValues({child: {a: 'a'}, child2}, [
1077
+ * child,
1078
+ * child2,
1079
+ * ]); // returns `undefined`
996
1080
  * ```
997
1081
  *
998
1082
  * @see
@@ -1238,13 +1322,31 @@ export const valueGuards = {
1238
1322
  * const child = {a: 'a'};
1239
1323
  * const child2 = {b: 'b'};
1240
1324
  *
1241
- * await waitUntil.hasValues([child, child2], () => {
1242
- * return {child, child2};
1243
- * }); // returns `{child, child2}`;
1244
- * await waitUntil.hasValues([child, child2], () => {
1245
- * return {child: {a: 'a'}, child2};
1246
- * }); // throws an error
1247
- * await waitUntil.hasValues([child, child2], () => [child]); // returns `[child]`;
1325
+ * await waitUntil.hasValues(
1326
+ * [
1327
+ * child,
1328
+ * child2,
1329
+ * ],
1330
+ * () => {
1331
+ * return {child, child2};
1332
+ * },
1333
+ * ); // returns `{child, child2}`;
1334
+ * await waitUntil.hasValues(
1335
+ * [
1336
+ * child,
1337
+ * child2,
1338
+ * ],
1339
+ * () => {
1340
+ * return {child: {a: 'a'}, child2};
1341
+ * },
1342
+ * ); // throws an error
1343
+ * await waitUntil.hasValues(
1344
+ * [
1345
+ * child,
1346
+ * child2,
1347
+ * ],
1348
+ * () => [child],
1349
+ * ); // returns `[child]`;
1248
1350
  * ```
1249
1351
  *
1250
1352
  * @returns The callback output once it passes.
@@ -1269,15 +1371,33 @@ export const valueGuards = {
1269
1371
  * const child = {a: 'a'};
1270
1372
  * const child2 = {b: 'b'};
1271
1373
  *
1272
- * await waitUntil.lacksValues([child, child2], () => {
1273
- * return {};
1274
- * }); // returns `{}`;
1275
- * await waitUntil.lacksValues([child, child2], () => {
1276
- * return {child, child2};
1277
- * }); // throws an error
1278
- * await waitUntil.lacksValues([child, child2], () => {
1279
- * return {child: {a: 'a'}, child2};
1280
- * }); // throws an error
1374
+ * await waitUntil.lacksValues(
1375
+ * [
1376
+ * child,
1377
+ * child2,
1378
+ * ],
1379
+ * () => {
1380
+ * return {};
1381
+ * },
1382
+ * ); // returns `{}`;
1383
+ * await waitUntil.lacksValues(
1384
+ * [
1385
+ * child,
1386
+ * child2,
1387
+ * ],
1388
+ * () => {
1389
+ * return {child, child2};
1390
+ * },
1391
+ * ); // throws an error
1392
+ * await waitUntil.lacksValues(
1393
+ * [
1394
+ * child,
1395
+ * child2,
1396
+ * ],
1397
+ * () => {
1398
+ * return {child: {a: 'a'}, child2};
1399
+ * },
1400
+ * ); // throws an error
1281
1401
  * ```
1282
1402
  *
1283
1403
  * @returns The callback output once it passes.
package/dist/augments/guards/wait-until.js CHANGED
@@ -44,5 +44,8 @@ export const waitUntil = Object.assign(function waitUntil(input, failureMessage)
44
44
  if (!input) {
45
45
  throw new AssertionError('Assertion failed.', failureMessage);
46
46
  }
47
- }, [input, failureMessage], false);
47
+ }, [
48
+ input,
49
+ failureMessage,
50
+ ], false);
48
51
  }, waitUntilMethods);
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@augment-vir/assert",
3
- "version": "31.9.1",
3
+ "version": "31.9.2",
4
4
  "description": "A collection of assertions for test and production code alike.",
5
5
  "keywords": [
6
6
  "augment",
@@ -41,22 +41,22 @@
41
41
  "test:update": "npm test"
42
42
  },
43
43
  "dependencies": {
44
- "@augment-vir/core": "^31.9.1",
45
- "@date-vir/duration": "^7.1.2",
44
+ "@augment-vir/core": "^31.9.2",
45
+ "@date-vir/duration": "^7.2.0",
46
46
  "deep-eql": "^5.0.2",
47
47
  "expect-type": "^1.1.0",
48
- "type-fest": "^4.33.0"
48
+ "type-fest": "^4.35.0"
49
49
  },
50
50
  "devDependencies": {
51
51
  "@types/deep-eql": "^4.0.2",
52
- "@web/dev-server-esbuild": "^1.0.3",
53
- "@web/test-runner": "^0.19.0",
52
+ "@web/dev-server-esbuild": "^1.0.4",
53
+ "@web/test-runner": "^0.20.0",
54
54
  "@web/test-runner-commands": "^0.9.0",
55
55
  "@web/test-runner-playwright": "^0.11.0",
56
56
  "@web/test-runner-visual-regression": "^0.10.0",
57
57
  "c8": "^10.1.3",
58
58
  "istanbul-smart-text-reporter": "^1.1.5",
59
- "typescript": "^5.7.2"
59
+ "typescript": "^5.7.3"
60
60
  },
61
61
  "engines": {
62
62
  "node": ">=22"