@xylabs/assert 2.9.1 → 2.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 (11) hide show
  1. package/dist/docs.json +241 -73
  2. package/docs/assets/highlight.css +50 -0
  3. package/docs/assets/main.js +58 -0
  4. package/docs/assets/search.js +1 -0
  5. package/docs/assets/style.css +1367 -0
  6. package/docs/functions/assertEx.html +108 -0
  7. package/docs/index.html +85 -0
  8. package/docs/modules.html +65 -0
  9. package/docs/types/AssertExErrorFunc.html +64 -0
  10. package/docs/types/AssertExMessageFunc.html +62 -0
  11. package/package.json +2 -2
package/dist/docs.json CHANGED
@@ -1,23 +1,22 @@
1
1
  {
2
2
  "id": 0,
3
3
  "name": "@xylabs/assert",
4
+ "variant": "project",
4
5
  "kind": 1,
5
- "kindString": "Project",
6
6
  "flags": {},
7
- "originalName": "",
8
7
  "children": [
9
8
  {
10
9
  "id": 26,
11
10
  "name": "default",
11
+ "variant": "reference",
12
12
  "kind": 8388608,
13
- "kindString": "Reference",
14
13
  "flags": {},
15
14
  "sources": [
16
15
  {
17
16
  "fileName": "index.ts",
18
17
  "line": 27,
19
18
  "character": 0,
20
- "url": "https://github.com/xylabs/sdk-js/blob/d4fefe1/packages/assert/src/index.ts#L27"
19
+ "url": "https://github.com/xylabs/sdk-js/blob/88ada5a/packages/assert/src/index.ts#L27"
21
20
  }
22
21
  ],
23
22
  "target": 12
@@ -25,35 +24,38 @@
25
24
  {
26
25
  "id": 6,
27
26
  "name": "AssertExErrorFunc",
27
+ "variant": "declaration",
28
28
  "kind": 4194304,
29
- "kindString": "Type alias",
30
29
  "flags": {},
31
30
  "sources": [
32
31
  {
33
32
  "fileName": "index.ts",
34
33
  "line": 2,
35
34
  "character": 12,
36
- "url": "https://github.com/xylabs/sdk-js/blob/d4fefe1/packages/assert/src/index.ts#L2"
35
+ "url": "https://github.com/xylabs/sdk-js/blob/88ada5a/packages/assert/src/index.ts#L2"
37
36
  }
38
37
  ],
39
38
  "typeParameters": [
40
39
  {
41
40
  "id": 10,
42
41
  "name": "T",
42
+ "variant": "typeParam",
43
43
  "kind": 131072,
44
- "kindString": "Type parameter",
45
44
  "flags": {}
46
45
  },
47
46
  {
48
47
  "id": 11,
49
48
  "name": "R",
49
+ "variant": "typeParam",
50
50
  "kind": 131072,
51
- "kindString": "Type parameter",
52
51
  "flags": {},
53
52
  "type": {
54
53
  "type": "reference",
54
+ "target": {
55
+ "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts",
56
+ "qualifiedName": "Error"
57
+ },
55
58
  "name": "Error",
56
- "qualifiedName": "Error",
57
59
  "package": "typescript"
58
60
  }
59
61
  }
@@ -63,30 +65,30 @@
63
65
  "declaration": {
64
66
  "id": 7,
65
67
  "name": "__type",
68
+ "variant": "declaration",
66
69
  "kind": 65536,
67
- "kindString": "Type literal",
68
70
  "flags": {},
69
71
  "sources": [
70
72
  {
71
73
  "fileName": "index.ts",
72
74
  "line": 2,
73
75
  "character": 52,
74
- "url": "https://github.com/xylabs/sdk-js/blob/d4fefe1/packages/assert/src/index.ts#L2"
76
+ "url": "https://github.com/xylabs/sdk-js/blob/88ada5a/packages/assert/src/index.ts#L2"
75
77
  }
76
78
  ],
77
79
  "signatures": [
78
80
  {
79
81
  "id": 8,
80
82
  "name": "__type",
83
+ "variant": "signature",
81
84
  "kind": 4096,
82
- "kindString": "Call signature",
83
85
  "flags": {},
84
86
  "parameters": [
85
87
  {
86
88
  "id": 9,
87
89
  "name": "value",
90
+ "variant": "param",
88
91
  "kind": 32768,
89
- "kindString": "Parameter",
90
92
  "flags": {
91
93
  "isOptional": true
92
94
  },
@@ -95,8 +97,9 @@
95
97
  "types": [
96
98
  {
97
99
  "type": "reference",
98
- "id": 10,
99
- "name": "T"
100
+ "target": -1,
101
+ "name": "T",
102
+ "refersToTypeParameter": true
100
103
  },
101
104
  {
102
105
  "type": "literal",
@@ -108,8 +111,9 @@
108
111
  ],
109
112
  "type": {
110
113
  "type": "reference",
111
- "id": 11,
112
- "name": "R"
114
+ "target": -1,
115
+ "name": "R",
116
+ "refersToTypeParameter": true
113
117
  }
114
118
  }
115
119
  ]
@@ -119,23 +123,23 @@
119
123
  {
120
124
  "id": 1,
121
125
  "name": "AssertExMessageFunc",
126
+ "variant": "declaration",
122
127
  "kind": 4194304,
123
- "kindString": "Type alias",
124
128
  "flags": {},
125
129
  "sources": [
126
130
  {
127
131
  "fileName": "index.ts",
128
132
  "line": 1,
129
133
  "character": 12,
130
- "url": "https://github.com/xylabs/sdk-js/blob/d4fefe1/packages/assert/src/index.ts#L1"
134
+ "url": "https://github.com/xylabs/sdk-js/blob/88ada5a/packages/assert/src/index.ts#L1"
131
135
  }
132
136
  ],
133
137
  "typeParameters": [
134
138
  {
135
139
  "id": 5,
136
140
  "name": "T",
141
+ "variant": "typeParam",
137
142
  "kind": 131072,
138
- "kindString": "Type parameter",
139
143
  "flags": {}
140
144
  }
141
145
  ],
@@ -144,30 +148,30 @@
144
148
  "declaration": {
145
149
  "id": 2,
146
150
  "name": "__type",
151
+ "variant": "declaration",
147
152
  "kind": 65536,
148
- "kindString": "Type literal",
149
153
  "flags": {},
150
154
  "sources": [
151
155
  {
152
156
  "fileName": "index.ts",
153
157
  "line": 1,
154
158
  "character": 37,
155
- "url": "https://github.com/xylabs/sdk-js/blob/d4fefe1/packages/assert/src/index.ts#L1"
159
+ "url": "https://github.com/xylabs/sdk-js/blob/88ada5a/packages/assert/src/index.ts#L1"
156
160
  }
157
161
  ],
158
162
  "signatures": [
159
163
  {
160
164
  "id": 3,
161
165
  "name": "__type",
166
+ "variant": "signature",
162
167
  "kind": 4096,
163
- "kindString": "Call signature",
164
168
  "flags": {},
165
169
  "parameters": [
166
170
  {
167
171
  "id": 4,
168
172
  "name": "value",
173
+ "variant": "param",
169
174
  "kind": 32768,
170
- "kindString": "Parameter",
171
175
  "flags": {
172
176
  "isOptional": true
173
177
  },
@@ -176,8 +180,9 @@
176
180
  "types": [
177
181
  {
178
182
  "type": "reference",
179
- "id": 5,
180
- "name": "T"
183
+ "target": -1,
184
+ "name": "T",
185
+ "refersToTypeParameter": true
181
186
  },
182
187
  {
183
188
  "type": "literal",
@@ -199,41 +204,41 @@
199
204
  {
200
205
  "id": 12,
201
206
  "name": "assertEx",
207
+ "variant": "declaration",
202
208
  "kind": 64,
203
- "kindString": "Function",
204
209
  "flags": {},
205
210
  "sources": [
206
211
  {
207
212
  "fileName": "index.ts",
208
213
  "line": 13,
209
214
  "character": 9,
210
- "url": "https://github.com/xylabs/sdk-js/blob/d4fefe1/packages/assert/src/index.ts#L13"
215
+ "url": "https://github.com/xylabs/sdk-js/blob/88ada5a/packages/assert/src/index.ts#L13"
211
216
  },
212
217
  {
213
218
  "fileName": "index.ts",
214
219
  "line": 14,
215
220
  "character": 9,
216
- "url": "https://github.com/xylabs/sdk-js/blob/d4fefe1/packages/assert/src/index.ts#L14"
221
+ "url": "https://github.com/xylabs/sdk-js/blob/88ada5a/packages/assert/src/index.ts#L14"
217
222
  },
218
223
  {
219
224
  "fileName": "index.ts",
220
225
  "line": 15,
221
226
  "character": 9,
222
- "url": "https://github.com/xylabs/sdk-js/blob/d4fefe1/packages/assert/src/index.ts#L15"
227
+ "url": "https://github.com/xylabs/sdk-js/blob/88ada5a/packages/assert/src/index.ts#L15"
223
228
  },
224
229
  {
225
230
  "fileName": "index.ts",
226
231
  "line": 16,
227
232
  "character": 9,
228
- "url": "https://github.com/xylabs/sdk-js/blob/d4fefe1/packages/assert/src/index.ts#L16"
233
+ "url": "https://github.com/xylabs/sdk-js/blob/88ada5a/packages/assert/src/index.ts#L16"
229
234
  }
230
235
  ],
231
236
  "signatures": [
232
237
  {
233
238
  "id": 13,
234
239
  "name": "assertEx",
240
+ "variant": "signature",
235
241
  "kind": 4096,
236
- "kindString": "Call signature",
237
242
  "flags": {},
238
243
  "comment": {
239
244
  "summary": [
@@ -263,12 +268,20 @@
263
268
  }
264
269
  ]
265
270
  },
271
+ "sources": [
272
+ {
273
+ "fileName": "index.ts",
274
+ "line": 13,
275
+ "character": 0,
276
+ "url": "https://github.com/xylabs/sdk-js/blob/88ada5a/packages/assert/src/index.ts#L13"
277
+ }
278
+ ],
266
279
  "typeParameter": [
267
280
  {
268
281
  "id": 14,
269
282
  "name": "T",
283
+ "variant": "typeParam",
270
284
  "kind": 131072,
271
- "kindString": "Type parameter",
272
285
  "flags": {}
273
286
  }
274
287
  ],
@@ -276,8 +289,8 @@
276
289
  {
277
290
  "id": 15,
278
291
  "name": "expr",
292
+ "variant": "param",
279
293
  "kind": 32768,
280
- "kindString": "Parameter",
281
294
  "flags": {
282
295
  "isOptional": true
283
296
  },
@@ -298,8 +311,9 @@
298
311
  },
299
312
  {
300
313
  "type": "reference",
301
- "id": 14,
302
- "name": "T"
314
+ "target": -1,
315
+ "name": "T",
316
+ "refersToTypeParameter": true
303
317
  }
304
318
  ]
305
319
  }
@@ -307,8 +321,8 @@
307
321
  {
308
322
  "id": 16,
309
323
  "name": "message",
324
+ "variant": "param",
310
325
  "kind": 32768,
311
- "kindString": "Parameter",
312
326
  "flags": {
313
327
  "isOptional": true
314
328
  },
@@ -328,22 +342,31 @@
328
342
  ],
329
343
  "type": {
330
344
  "type": "reference",
331
- "id": 14,
332
- "name": "T"
345
+ "target": -1,
346
+ "name": "T",
347
+ "refersToTypeParameter": true
333
348
  }
334
349
  },
335
350
  {
336
351
  "id": 17,
337
352
  "name": "assertEx",
353
+ "variant": "signature",
338
354
  "kind": 4096,
339
- "kindString": "Call signature",
340
355
  "flags": {},
356
+ "sources": [
357
+ {
358
+ "fileName": "index.ts",
359
+ "line": 14,
360
+ "character": 0,
361
+ "url": "https://github.com/xylabs/sdk-js/blob/88ada5a/packages/assert/src/index.ts#L14"
362
+ }
363
+ ],
341
364
  "typeParameter": [
342
365
  {
343
366
  "id": 18,
344
367
  "name": "T",
368
+ "variant": "typeParam",
345
369
  "kind": 131072,
346
- "kindString": "Type parameter",
347
370
  "flags": {}
348
371
  }
349
372
  ],
@@ -351,8 +374,8 @@
351
374
  {
352
375
  "id": 19,
353
376
  "name": "expr",
377
+ "variant": "param",
354
378
  "kind": 32768,
355
- "kindString": "Parameter",
356
379
  "flags": {
357
380
  "isOptional": true
358
381
  },
@@ -365,8 +388,9 @@
365
388
  },
366
389
  {
367
390
  "type": "reference",
368
- "id": 18,
369
- "name": "T"
391
+ "target": -1,
392
+ "name": "T",
393
+ "refersToTypeParameter": true
370
394
  }
371
395
  ]
372
396
  }
@@ -374,55 +398,69 @@
374
398
  {
375
399
  "id": 20,
376
400
  "name": "messageFunc",
401
+ "variant": "param",
377
402
  "kind": 32768,
378
- "kindString": "Parameter",
379
403
  "flags": {
380
404
  "isOptional": true
381
405
  },
382
406
  "type": {
383
407
  "type": "reference",
384
- "id": 1,
408
+ "target": 1,
385
409
  "typeArguments": [
386
410
  {
387
411
  "type": "reference",
388
- "id": 18,
389
- "name": "T"
412
+ "target": -1,
413
+ "name": "T",
414
+ "refersToTypeParameter": true
390
415
  }
391
416
  ],
392
- "name": "AssertExMessageFunc"
417
+ "name": "AssertExMessageFunc",
418
+ "package": "@xylabs/assert"
393
419
  }
394
420
  }
395
421
  ],
396
422
  "type": {
397
423
  "type": "reference",
398
- "id": 18,
399
- "name": "T"
424
+ "target": -1,
425
+ "name": "T",
426
+ "refersToTypeParameter": true
400
427
  }
401
428
  },
402
429
  {
403
430
  "id": 21,
404
431
  "name": "assertEx",
432
+ "variant": "signature",
405
433
  "kind": 4096,
406
- "kindString": "Call signature",
407
434
  "flags": {},
435
+ "sources": [
436
+ {
437
+ "fileName": "index.ts",
438
+ "line": 15,
439
+ "character": 0,
440
+ "url": "https://github.com/xylabs/sdk-js/blob/88ada5a/packages/assert/src/index.ts#L15"
441
+ }
442
+ ],
408
443
  "typeParameter": [
409
444
  {
410
445
  "id": 22,
411
446
  "name": "T",
447
+ "variant": "typeParam",
412
448
  "kind": 131072,
413
- "kindString": "Type parameter",
414
449
  "flags": {}
415
450
  },
416
451
  {
417
452
  "id": 23,
418
453
  "name": "R",
454
+ "variant": "typeParam",
419
455
  "kind": 131072,
420
- "kindString": "Type parameter",
421
456
  "flags": {},
422
457
  "type": {
423
458
  "type": "reference",
459
+ "target": {
460
+ "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts",
461
+ "qualifiedName": "Error"
462
+ },
424
463
  "name": "Error",
425
- "qualifiedName": "Error",
426
464
  "package": "typescript"
427
465
  }
428
466
  }
@@ -431,8 +469,8 @@
431
469
  {
432
470
  "id": 24,
433
471
  "name": "expr",
472
+ "variant": "param",
434
473
  "kind": 32768,
435
- "kindString": "Parameter",
436
474
  "flags": {
437
475
  "isOptional": true
438
476
  },
@@ -445,8 +483,9 @@
445
483
  },
446
484
  {
447
485
  "type": "reference",
448
- "id": 22,
449
- "name": "T"
486
+ "target": -1,
487
+ "name": "T",
488
+ "refersToTypeParameter": true
450
489
  }
451
490
  ]
452
491
  }
@@ -454,34 +493,38 @@
454
493
  {
455
494
  "id": 25,
456
495
  "name": "errorFunc",
496
+ "variant": "param",
457
497
  "kind": 32768,
458
- "kindString": "Parameter",
459
498
  "flags": {
460
499
  "isOptional": true
461
500
  },
462
501
  "type": {
463
502
  "type": "reference",
464
- "id": 6,
503
+ "target": 6,
465
504
  "typeArguments": [
466
505
  {
467
506
  "type": "reference",
468
- "id": 22,
469
- "name": "T"
507
+ "target": -1,
508
+ "name": "T",
509
+ "refersToTypeParameter": true
470
510
  },
471
511
  {
472
512
  "type": "reference",
473
- "id": 23,
474
- "name": "R"
513
+ "target": -1,
514
+ "name": "R",
515
+ "refersToTypeParameter": true
475
516
  }
476
517
  ],
477
- "name": "AssertExErrorFunc"
518
+ "name": "AssertExErrorFunc",
519
+ "package": "@xylabs/assert"
478
520
  }
479
521
  }
480
522
  ],
481
523
  "type": {
482
524
  "type": "reference",
483
- "id": 22,
484
- "name": "T"
525
+ "target": -1,
526
+ "name": "T",
527
+ "refersToTypeParameter": true
485
528
  }
486
529
  }
487
530
  ]
@@ -508,12 +551,137 @@
508
551
  ]
509
552
  }
510
553
  ],
511
- "sources": [
554
+ "packageName": "@xylabs/assert",
555
+ "readme": [
556
+ {
557
+ "kind": "text",
558
+ "text": "[![logo][]](https://xylabs.com)\n\n# @xylabs/sdk-js\n\n[![main-build][]][main-build-link]\n[![beta-build][]][beta-build-link]\n[![npm-badge][]][npm-link]\n[![bch-badge][]][bch-link]\n[![codacy-badge][]][codacy-link]\n[![codeclimate-badge][]][codeclimate-link]\n[![snyk-badge][]][snyk-link]\n\n## Table of Contents\n\n- [Description](#description)\n- [Install](#install)\n- [Scripts](#scripts)\n- [Maintainers](#maintainers)\n- [License](#license)\n- [Credits](#credits)\n\n## Description\n\nSDK for base code for Typescript and Javascript Libraries.\n\n## Install\n\nUsing npm:\n\n"
559
+ },
560
+ {
561
+ "kind": "code",
562
+ "text": "```sh\nnpm i --save @xylabs/sdk-js\n```"
563
+ },
512
564
  {
513
- "fileName": "index.ts",
514
- "line": 1,
515
- "character": 0,
516
- "url": "https://github.com/xylabs/sdk-js/blob/d4fefe1/packages/assert/src/index.ts#L1"
565
+ "kind": "text",
566
+ "text": "\n\nUsing yarn:\n\n"
567
+ },
568
+ {
569
+ "kind": "code",
570
+ "text": "```sh\nyarn add @xylabs/sdk-js\n```"
571
+ },
572
+ {
573
+ "kind": "text",
574
+ "text": "\n\n## Scripts\n\nSee [ts-scripts](https://github.com/xylabs/ts-scripts/blob/main/README.md)\nfor list of shared scripts.\n\n## Maintainers\n\n- [Arie Trouw](https://github.com/arietrouw) (<https://arietrouw.com>)\n\n## License\n\nSee the [LICENSE](LICENSE) file for license details\n\n## Credits\n\n[Made with 🔥 and ❄️ by XY Labs](https://xylabs.com)\n\n[logo]: https://cdn.xy.company/img/brand/XYPersistentCompany_Logo_Icon_Colored.svg\n[main-build]: https://github.com/xylabs/sdk-js/actions/workflows/build-main.yml/badge.svg\n[main-build-link]: https://github.com/xylabs/sdk-js/actions/workflows/build-main.yml\n[beta-build]: https://github.com/xylabs/sdk-js/actions/workflows/build-beta.yml/badge.svg\n[beta-build-link]: https://github.com/xylabs/sdk-js/actions/workflows/build-beta.yml\n[npm-badge]: https://img.shields.io/npm/v/@xylabs/sdk-js.svg\n[npm-link]: https://www.npmjs.com/package/@xylabs/sdk-js\n[bch-badge]: https://bettercodehub.com/edge/badge/xylabs/sdk-js?branch=main\n[bch-link]: https://bettercodehub.com/results/xylabs/sdk-js\n[codacy-badge]: https://app.codacy.com/project/badge/Grade/c8e15e14f37741c18cfb47ac7245c698\n[codacy-link]: https://www.codacy.com/gh/xylabs/sdk-js/dashboard?utm_source=github.com&utm_medium=referral&utm_content=xylabs/sdk-js&utm_campaign=Badge_Grade\n[codeclimate-badge]: https://api.codeclimate.com/v1/badges/c5eb068f806f0b047ea7/maintainability\n[codeclimate-link]: https://codeclimate.com/github/xylabs/sdk-js/maintainability\n[snyk-badge]: https://snyk.io/test/github/xylabs/sdk-js/badge.svg?targetFile=package.json\n[snyk-link]: https://snyk.io/test/github/xylabs/sdk-js?targetFile=package.json"
575
+ }
576
+ ],
577
+ "symbolIdMap": {
578
+ "0": {
579
+ "sourceFileName": "src/index.ts",
580
+ "qualifiedName": ""
581
+ },
582
+ "1": {
583
+ "sourceFileName": "src/index.ts",
584
+ "qualifiedName": "AssertExMessageFunc"
585
+ },
586
+ "2": {
587
+ "sourceFileName": "src/index.ts",
588
+ "qualifiedName": "__type"
589
+ },
590
+ "3": {
591
+ "sourceFileName": "src/index.ts",
592
+ "qualifiedName": "__type"
593
+ },
594
+ "4": {
595
+ "sourceFileName": "src/index.ts",
596
+ "qualifiedName": "value"
597
+ },
598
+ "5": {
599
+ "sourceFileName": "src/index.ts",
600
+ "qualifiedName": "T"
601
+ },
602
+ "6": {
603
+ "sourceFileName": "src/index.ts",
604
+ "qualifiedName": "AssertExErrorFunc"
605
+ },
606
+ "7": {
607
+ "sourceFileName": "src/index.ts",
608
+ "qualifiedName": "__type"
609
+ },
610
+ "8": {
611
+ "sourceFileName": "src/index.ts",
612
+ "qualifiedName": "__type"
613
+ },
614
+ "9": {
615
+ "sourceFileName": "src/index.ts",
616
+ "qualifiedName": "value"
617
+ },
618
+ "10": {
619
+ "sourceFileName": "src/index.ts",
620
+ "qualifiedName": "T"
621
+ },
622
+ "11": {
623
+ "sourceFileName": "src/index.ts",
624
+ "qualifiedName": "R"
625
+ },
626
+ "12": {
627
+ "sourceFileName": "src/index.ts",
628
+ "qualifiedName": "assertEx"
629
+ },
630
+ "13": {
631
+ "sourceFileName": "src/index.ts",
632
+ "qualifiedName": "assertEx"
633
+ },
634
+ "14": {
635
+ "sourceFileName": "src/index.ts",
636
+ "qualifiedName": "T"
637
+ },
638
+ "15": {
639
+ "sourceFileName": "src/index.ts",
640
+ "qualifiedName": "expr"
641
+ },
642
+ "16": {
643
+ "sourceFileName": "src/index.ts",
644
+ "qualifiedName": "message"
645
+ },
646
+ "17": {
647
+ "sourceFileName": "src/index.ts",
648
+ "qualifiedName": "assertEx"
649
+ },
650
+ "18": {
651
+ "sourceFileName": "src/index.ts",
652
+ "qualifiedName": "T"
653
+ },
654
+ "19": {
655
+ "sourceFileName": "src/index.ts",
656
+ "qualifiedName": "expr"
657
+ },
658
+ "20": {
659
+ "sourceFileName": "src/index.ts",
660
+ "qualifiedName": "messageFunc"
661
+ },
662
+ "21": {
663
+ "sourceFileName": "src/index.ts",
664
+ "qualifiedName": "assertEx"
665
+ },
666
+ "22": {
667
+ "sourceFileName": "src/index.ts",
668
+ "qualifiedName": "T"
669
+ },
670
+ "23": {
671
+ "sourceFileName": "src/index.ts",
672
+ "qualifiedName": "R"
673
+ },
674
+ "24": {
675
+ "sourceFileName": "src/index.ts",
676
+ "qualifiedName": "expr"
677
+ },
678
+ "25": {
679
+ "sourceFileName": "src/index.ts",
680
+ "qualifiedName": "errorFunc"
681
+ },
682
+ "26": {
683
+ "sourceFileName": "src/index.ts",
684
+ "qualifiedName": "default"
517
685
  }
518
- ]
686
+ }
519
687
  }