@xyo-network/typeof 2.74.0 → 2.74.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 (2) hide show
  1. package/dist/docs.json +757 -0
  2. package/package.json +3 -3
package/dist/docs.json ADDED
@@ -0,0 +1,757 @@
1
+ {
2
+ "id": 0,
3
+ "name": "@xyo-network/typeof",
4
+ "variant": "project",
5
+ "kind": 1,
6
+ "flags": {},
7
+ "children": [
8
+ {
9
+ "id": 27,
10
+ "name": "TypeOfTypes",
11
+ "variant": "declaration",
12
+ "kind": 4194304,
13
+ "flags": {},
14
+ "sources": [
15
+ {
16
+ "fileName": "TypeOfTypes.ts",
17
+ "line": 1,
18
+ "character": 12,
19
+ "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/6e59657e618a7/packages/shared/packages/typeof/src/TypeOfTypes.ts#L1"
20
+ }
21
+ ],
22
+ "type": {
23
+ "type": "union",
24
+ "types": [
25
+ {
26
+ "type": "literal",
27
+ "value": "string"
28
+ },
29
+ {
30
+ "type": "literal",
31
+ "value": "number"
32
+ },
33
+ {
34
+ "type": "literal",
35
+ "value": "object"
36
+ },
37
+ {
38
+ "type": "literal",
39
+ "value": "array"
40
+ },
41
+ {
42
+ "type": "literal",
43
+ "value": "buffer"
44
+ },
45
+ {
46
+ "type": "literal",
47
+ "value": "null"
48
+ },
49
+ {
50
+ "type": "literal",
51
+ "value": "undefined"
52
+ },
53
+ {
54
+ "type": "literal",
55
+ "value": "bigint"
56
+ },
57
+ {
58
+ "type": "literal",
59
+ "value": "boolean"
60
+ },
61
+ {
62
+ "type": "literal",
63
+ "value": "function"
64
+ },
65
+ {
66
+ "type": "literal",
67
+ "value": "symbol"
68
+ }
69
+ ]
70
+ }
71
+ },
72
+ {
73
+ "id": 1,
74
+ "name": "ifDefined",
75
+ "variant": "declaration",
76
+ "kind": 64,
77
+ "flags": {},
78
+ "sources": [
79
+ {
80
+ "fileName": "ifDefined.ts",
81
+ "line": 3,
82
+ "character": 13,
83
+ "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/6e59657e618a7/packages/shared/packages/typeof/src/ifDefined.ts#L3"
84
+ }
85
+ ],
86
+ "signatures": [
87
+ {
88
+ "id": 2,
89
+ "name": "ifDefined",
90
+ "variant": "signature",
91
+ "kind": 4096,
92
+ "flags": {},
93
+ "sources": [
94
+ {
95
+ "fileName": "ifDefined.ts",
96
+ "line": 3,
97
+ "character": 25,
98
+ "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/6e59657e618a7/packages/shared/packages/typeof/src/ifDefined.ts#L3"
99
+ }
100
+ ],
101
+ "typeParameter": [
102
+ {
103
+ "id": 3,
104
+ "name": "T",
105
+ "variant": "typeParam",
106
+ "kind": 131072,
107
+ "flags": {}
108
+ }
109
+ ],
110
+ "parameters": [
111
+ {
112
+ "id": 4,
113
+ "name": "value",
114
+ "variant": "param",
115
+ "kind": 32768,
116
+ "flags": {},
117
+ "type": {
118
+ "type": "reference",
119
+ "target": -1,
120
+ "name": "T",
121
+ "refersToTypeParameter": true
122
+ }
123
+ },
124
+ {
125
+ "id": 5,
126
+ "name": "func",
127
+ "variant": "param",
128
+ "kind": 32768,
129
+ "flags": {},
130
+ "type": {
131
+ "type": "reflection",
132
+ "declaration": {
133
+ "id": 6,
134
+ "name": "__type",
135
+ "variant": "declaration",
136
+ "kind": 65536,
137
+ "flags": {},
138
+ "sources": [
139
+ {
140
+ "fileName": "ifDefined.ts",
141
+ "line": 3,
142
+ "character": 45,
143
+ "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/6e59657e618a7/packages/shared/packages/typeof/src/ifDefined.ts#L3"
144
+ }
145
+ ],
146
+ "signatures": [
147
+ {
148
+ "id": 7,
149
+ "name": "__type",
150
+ "variant": "signature",
151
+ "kind": 4096,
152
+ "flags": {},
153
+ "sources": [
154
+ {
155
+ "fileName": "ifDefined.ts",
156
+ "line": 3,
157
+ "character": 45,
158
+ "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/6e59657e618a7/packages/shared/packages/typeof/src/ifDefined.ts#L3"
159
+ }
160
+ ],
161
+ "parameters": [
162
+ {
163
+ "id": 8,
164
+ "name": "value",
165
+ "variant": "param",
166
+ "kind": 32768,
167
+ "flags": {},
168
+ "type": {
169
+ "type": "reference",
170
+ "target": -1,
171
+ "name": "T",
172
+ "refersToTypeParameter": true
173
+ }
174
+ }
175
+ ],
176
+ "type": {
177
+ "type": "intrinsic",
178
+ "name": "void"
179
+ }
180
+ }
181
+ ]
182
+ }
183
+ }
184
+ }
185
+ ],
186
+ "type": {
187
+ "type": "union",
188
+ "types": [
189
+ {
190
+ "type": "intrinsic",
191
+ "name": "undefined"
192
+ },
193
+ {
194
+ "type": "reference",
195
+ "target": -1,
196
+ "name": "T",
197
+ "refersToTypeParameter": true
198
+ }
199
+ ]
200
+ }
201
+ }
202
+ ]
203
+ },
204
+ {
205
+ "id": 9,
206
+ "name": "ifTypeOf",
207
+ "variant": "declaration",
208
+ "kind": 64,
209
+ "flags": {},
210
+ "sources": [
211
+ {
212
+ "fileName": "ifTypeOf.ts",
213
+ "line": 4,
214
+ "character": 13,
215
+ "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/6e59657e618a7/packages/shared/packages/typeof/src/ifTypeOf.ts#L4"
216
+ }
217
+ ],
218
+ "signatures": [
219
+ {
220
+ "id": 10,
221
+ "name": "ifTypeOf",
222
+ "variant": "signature",
223
+ "kind": 4096,
224
+ "flags": {},
225
+ "sources": [
226
+ {
227
+ "fileName": "ifTypeOf.ts",
228
+ "line": 4,
229
+ "character": 24,
230
+ "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/6e59657e618a7/packages/shared/packages/typeof/src/ifTypeOf.ts#L4"
231
+ }
232
+ ],
233
+ "typeParameter": [
234
+ {
235
+ "id": 11,
236
+ "name": "T",
237
+ "variant": "typeParam",
238
+ "kind": 131072,
239
+ "flags": {}
240
+ },
241
+ {
242
+ "id": 12,
243
+ "name": "R",
244
+ "variant": "typeParam",
245
+ "kind": 131072,
246
+ "flags": {}
247
+ }
248
+ ],
249
+ "parameters": [
250
+ {
251
+ "id": 13,
252
+ "name": "typeName",
253
+ "variant": "param",
254
+ "kind": 32768,
255
+ "flags": {},
256
+ "type": {
257
+ "type": "reference",
258
+ "target": 27,
259
+ "name": "TypeOfTypes",
260
+ "package": "@xyo-network/typeof"
261
+ }
262
+ },
263
+ {
264
+ "id": 14,
265
+ "name": "value",
266
+ "variant": "param",
267
+ "kind": 32768,
268
+ "flags": {},
269
+ "type": {
270
+ "type": "intrinsic",
271
+ "name": "unknown"
272
+ }
273
+ },
274
+ {
275
+ "id": 15,
276
+ "name": "trueFunc",
277
+ "variant": "param",
278
+ "kind": 32768,
279
+ "flags": {},
280
+ "type": {
281
+ "type": "reflection",
282
+ "declaration": {
283
+ "id": 16,
284
+ "name": "__type",
285
+ "variant": "declaration",
286
+ "kind": 65536,
287
+ "flags": {},
288
+ "sources": [
289
+ {
290
+ "fileName": "ifTypeOf.ts",
291
+ "line": 4,
292
+ "character": 80,
293
+ "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/6e59657e618a7/packages/shared/packages/typeof/src/ifTypeOf.ts#L4"
294
+ }
295
+ ],
296
+ "signatures": [
297
+ {
298
+ "id": 17,
299
+ "name": "__type",
300
+ "variant": "signature",
301
+ "kind": 4096,
302
+ "flags": {},
303
+ "sources": [
304
+ {
305
+ "fileName": "ifTypeOf.ts",
306
+ "line": 4,
307
+ "character": 80,
308
+ "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/6e59657e618a7/packages/shared/packages/typeof/src/ifTypeOf.ts#L4"
309
+ }
310
+ ],
311
+ "parameters": [
312
+ {
313
+ "id": 18,
314
+ "name": "value",
315
+ "variant": "param",
316
+ "kind": 32768,
317
+ "flags": {},
318
+ "type": {
319
+ "type": "reference",
320
+ "target": -1,
321
+ "name": "T",
322
+ "refersToTypeParameter": true
323
+ }
324
+ }
325
+ ],
326
+ "type": {
327
+ "type": "reference",
328
+ "target": -1,
329
+ "name": "R",
330
+ "refersToTypeParameter": true
331
+ }
332
+ }
333
+ ]
334
+ }
335
+ }
336
+ },
337
+ {
338
+ "id": 19,
339
+ "name": "isFunc",
340
+ "variant": "param",
341
+ "kind": 32768,
342
+ "flags": {
343
+ "isOptional": true
344
+ },
345
+ "type": {
346
+ "type": "reflection",
347
+ "declaration": {
348
+ "id": 20,
349
+ "name": "__type",
350
+ "variant": "declaration",
351
+ "kind": 65536,
352
+ "flags": {},
353
+ "sources": [
354
+ {
355
+ "fileName": "ifTypeOf.ts",
356
+ "line": 4,
357
+ "character": 106,
358
+ "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/6e59657e618a7/packages/shared/packages/typeof/src/ifTypeOf.ts#L4"
359
+ }
360
+ ],
361
+ "signatures": [
362
+ {
363
+ "id": 21,
364
+ "name": "__type",
365
+ "variant": "signature",
366
+ "kind": 4096,
367
+ "flags": {},
368
+ "sources": [
369
+ {
370
+ "fileName": "ifTypeOf.ts",
371
+ "line": 4,
372
+ "character": 106,
373
+ "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/6e59657e618a7/packages/shared/packages/typeof/src/ifTypeOf.ts#L4"
374
+ }
375
+ ],
376
+ "parameters": [
377
+ {
378
+ "id": 22,
379
+ "name": "value",
380
+ "variant": "param",
381
+ "kind": 32768,
382
+ "flags": {},
383
+ "type": {
384
+ "type": "reference",
385
+ "target": -1,
386
+ "name": "T",
387
+ "refersToTypeParameter": true
388
+ }
389
+ }
390
+ ],
391
+ "type": {
392
+ "type": "intrinsic",
393
+ "name": "boolean"
394
+ }
395
+ }
396
+ ]
397
+ }
398
+ }
399
+ }
400
+ ],
401
+ "type": {
402
+ "type": "union",
403
+ "types": [
404
+ {
405
+ "type": "intrinsic",
406
+ "name": "undefined"
407
+ },
408
+ {
409
+ "type": "reference",
410
+ "target": -1,
411
+ "name": "R",
412
+ "refersToTypeParameter": true
413
+ }
414
+ ]
415
+ }
416
+ }
417
+ ]
418
+ },
419
+ {
420
+ "id": 23,
421
+ "name": "typeOf",
422
+ "variant": "declaration",
423
+ "kind": 64,
424
+ "flags": {},
425
+ "sources": [
426
+ {
427
+ "fileName": "typeOf.ts",
428
+ "line": 3,
429
+ "character": 13,
430
+ "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/6e59657e618a7/packages/shared/packages/typeof/src/typeOf.ts#L3"
431
+ }
432
+ ],
433
+ "signatures": [
434
+ {
435
+ "id": 24,
436
+ "name": "typeOf",
437
+ "variant": "signature",
438
+ "kind": 4096,
439
+ "flags": {},
440
+ "sources": [
441
+ {
442
+ "fileName": "typeOf.ts",
443
+ "line": 3,
444
+ "character": 22,
445
+ "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/6e59657e618a7/packages/shared/packages/typeof/src/typeOf.ts#L3"
446
+ }
447
+ ],
448
+ "typeParameter": [
449
+ {
450
+ "id": 25,
451
+ "name": "T",
452
+ "variant": "typeParam",
453
+ "kind": 131072,
454
+ "flags": {}
455
+ }
456
+ ],
457
+ "parameters": [
458
+ {
459
+ "id": 26,
460
+ "name": "item",
461
+ "variant": "param",
462
+ "kind": 32768,
463
+ "flags": {},
464
+ "type": {
465
+ "type": "reference",
466
+ "target": -1,
467
+ "name": "T",
468
+ "refersToTypeParameter": true
469
+ }
470
+ }
471
+ ],
472
+ "type": {
473
+ "type": "reference",
474
+ "target": 27,
475
+ "name": "TypeOfTypes",
476
+ "package": "@xyo-network/typeof"
477
+ }
478
+ }
479
+ ]
480
+ },
481
+ {
482
+ "id": 28,
483
+ "name": "validateType",
484
+ "variant": "declaration",
485
+ "kind": 64,
486
+ "flags": {},
487
+ "sources": [
488
+ {
489
+ "fileName": "validateType.ts",
490
+ "line": 4,
491
+ "character": 13,
492
+ "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/6e59657e618a7/packages/shared/packages/typeof/src/validateType.ts#L4"
493
+ }
494
+ ],
495
+ "signatures": [
496
+ {
497
+ "id": 29,
498
+ "name": "validateType",
499
+ "variant": "signature",
500
+ "kind": 4096,
501
+ "flags": {},
502
+ "sources": [
503
+ {
504
+ "fileName": "validateType.ts",
505
+ "line": 4,
506
+ "character": 28,
507
+ "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/6e59657e618a7/packages/shared/packages/typeof/src/validateType.ts#L4"
508
+ }
509
+ ],
510
+ "typeParameter": [
511
+ {
512
+ "id": 30,
513
+ "name": "T",
514
+ "variant": "typeParam",
515
+ "kind": 131072,
516
+ "flags": {}
517
+ }
518
+ ],
519
+ "parameters": [
520
+ {
521
+ "id": 31,
522
+ "name": "typeName",
523
+ "variant": "param",
524
+ "kind": 32768,
525
+ "flags": {},
526
+ "type": {
527
+ "type": "reference",
528
+ "target": 27,
529
+ "name": "TypeOfTypes",
530
+ "package": "@xyo-network/typeof"
531
+ }
532
+ },
533
+ {
534
+ "id": 32,
535
+ "name": "value",
536
+ "variant": "param",
537
+ "kind": 32768,
538
+ "flags": {},
539
+ "type": {
540
+ "type": "reference",
541
+ "target": -1,
542
+ "name": "T",
543
+ "refersToTypeParameter": true
544
+ }
545
+ },
546
+ {
547
+ "id": 33,
548
+ "name": "optional",
549
+ "variant": "param",
550
+ "kind": 32768,
551
+ "flags": {},
552
+ "type": {
553
+ "type": "intrinsic",
554
+ "name": "boolean"
555
+ },
556
+ "defaultValue": "false"
557
+ }
558
+ ],
559
+ "type": {
560
+ "type": "tuple",
561
+ "elements": [
562
+ {
563
+ "type": "union",
564
+ "types": [
565
+ {
566
+ "type": "intrinsic",
567
+ "name": "undefined"
568
+ },
569
+ {
570
+ "type": "reference",
571
+ "target": -1,
572
+ "name": "T",
573
+ "refersToTypeParameter": true
574
+ }
575
+ ]
576
+ },
577
+ {
578
+ "type": "array",
579
+ "elementType": {
580
+ "type": "reference",
581
+ "target": {
582
+ "sourceFileName": "../../../../node_modules/typescript/lib/lib.es5.d.ts",
583
+ "qualifiedName": "Error"
584
+ },
585
+ "name": "Error",
586
+ "package": "typescript"
587
+ }
588
+ }
589
+ ]
590
+ }
591
+ }
592
+ ]
593
+ }
594
+ ],
595
+ "groups": [
596
+ {
597
+ "title": "Type Aliases",
598
+ "children": [
599
+ 27
600
+ ]
601
+ },
602
+ {
603
+ "title": "Functions",
604
+ "children": [
605
+ 1,
606
+ 9,
607
+ 23,
608
+ 28
609
+ ]
610
+ }
611
+ ],
612
+ "packageName": "@xyo-network/typeof",
613
+ "readme": [
614
+ {
615
+ "kind": "text",
616
+ "text": "[![logo][]](https://xyo.network)\n\nPart of [sdk-xyo-clint-js](https://www.npmjs.com/package/@xyo-network/sdk-xyo-client-js)\n\n## License\n\n> See the [LICENSE](LICENSE) file for license details\n\n## Credits\n\n[Made with 🔥 and ❄️ by XYO](https://xyo.network)\n\n[logo]: https://cdn.xy.company/img/brand/XYO_full_colored.png"
617
+ }
618
+ ],
619
+ "symbolIdMap": {
620
+ "0": {
621
+ "sourceFileName": "src/index.ts",
622
+ "qualifiedName": ""
623
+ },
624
+ "1": {
625
+ "sourceFileName": "src/ifDefined.ts",
626
+ "qualifiedName": "ifDefined"
627
+ },
628
+ "2": {
629
+ "sourceFileName": "src/ifDefined.ts",
630
+ "qualifiedName": "ifDefined"
631
+ },
632
+ "3": {
633
+ "sourceFileName": "src/ifDefined.ts",
634
+ "qualifiedName": "T"
635
+ },
636
+ "4": {
637
+ "sourceFileName": "src/ifDefined.ts",
638
+ "qualifiedName": "value"
639
+ },
640
+ "5": {
641
+ "sourceFileName": "src/ifDefined.ts",
642
+ "qualifiedName": "func"
643
+ },
644
+ "6": {
645
+ "sourceFileName": "src/ifDefined.ts",
646
+ "qualifiedName": "__type"
647
+ },
648
+ "7": {
649
+ "sourceFileName": "src/ifDefined.ts",
650
+ "qualifiedName": "__type"
651
+ },
652
+ "8": {
653
+ "sourceFileName": "src/ifDefined.ts",
654
+ "qualifiedName": "value"
655
+ },
656
+ "9": {
657
+ "sourceFileName": "src/ifTypeOf.ts",
658
+ "qualifiedName": "ifTypeOf"
659
+ },
660
+ "10": {
661
+ "sourceFileName": "src/ifTypeOf.ts",
662
+ "qualifiedName": "ifTypeOf"
663
+ },
664
+ "11": {
665
+ "sourceFileName": "src/ifTypeOf.ts",
666
+ "qualifiedName": "T"
667
+ },
668
+ "12": {
669
+ "sourceFileName": "src/ifTypeOf.ts",
670
+ "qualifiedName": "R"
671
+ },
672
+ "13": {
673
+ "sourceFileName": "src/ifTypeOf.ts",
674
+ "qualifiedName": "typeName"
675
+ },
676
+ "14": {
677
+ "sourceFileName": "src/ifTypeOf.ts",
678
+ "qualifiedName": "value"
679
+ },
680
+ "15": {
681
+ "sourceFileName": "src/ifTypeOf.ts",
682
+ "qualifiedName": "trueFunc"
683
+ },
684
+ "16": {
685
+ "sourceFileName": "src/ifTypeOf.ts",
686
+ "qualifiedName": "__type"
687
+ },
688
+ "17": {
689
+ "sourceFileName": "src/ifTypeOf.ts",
690
+ "qualifiedName": "__type"
691
+ },
692
+ "18": {
693
+ "sourceFileName": "src/ifTypeOf.ts",
694
+ "qualifiedName": "value"
695
+ },
696
+ "19": {
697
+ "sourceFileName": "src/ifTypeOf.ts",
698
+ "qualifiedName": "isFunc"
699
+ },
700
+ "20": {
701
+ "sourceFileName": "src/ifTypeOf.ts",
702
+ "qualifiedName": "__type"
703
+ },
704
+ "21": {
705
+ "sourceFileName": "src/ifTypeOf.ts",
706
+ "qualifiedName": "__type"
707
+ },
708
+ "22": {
709
+ "sourceFileName": "src/ifTypeOf.ts",
710
+ "qualifiedName": "value"
711
+ },
712
+ "23": {
713
+ "sourceFileName": "src/typeOf.ts",
714
+ "qualifiedName": "typeOf"
715
+ },
716
+ "24": {
717
+ "sourceFileName": "src/typeOf.ts",
718
+ "qualifiedName": "typeOf"
719
+ },
720
+ "25": {
721
+ "sourceFileName": "src/typeOf.ts",
722
+ "qualifiedName": "T"
723
+ },
724
+ "26": {
725
+ "sourceFileName": "src/typeOf.ts",
726
+ "qualifiedName": "item"
727
+ },
728
+ "27": {
729
+ "sourceFileName": "src/TypeOfTypes.ts",
730
+ "qualifiedName": "TypeOfTypes"
731
+ },
732
+ "28": {
733
+ "sourceFileName": "src/validateType.ts",
734
+ "qualifiedName": "validateType"
735
+ },
736
+ "29": {
737
+ "sourceFileName": "src/validateType.ts",
738
+ "qualifiedName": "validateType"
739
+ },
740
+ "30": {
741
+ "sourceFileName": "src/validateType.ts",
742
+ "qualifiedName": "T"
743
+ },
744
+ "31": {
745
+ "sourceFileName": "src/validateType.ts",
746
+ "qualifiedName": "typeName"
747
+ },
748
+ "32": {
749
+ "sourceFileName": "src/validateType.ts",
750
+ "qualifiedName": "value"
751
+ },
752
+ "33": {
753
+ "sourceFileName": "src/validateType.ts",
754
+ "qualifiedName": "optional"
755
+ }
756
+ }
757
+ }
package/package.json CHANGED
@@ -11,8 +11,8 @@
11
11
  },
12
12
  "description": "Primary SDK for using XYO Protocol 2.0",
13
13
  "devDependencies": {
14
- "@xylabs/ts-scripts-yarn3": "^3.0.27",
15
- "@xylabs/tsconfig": "^3.0.27",
14
+ "@xylabs/ts-scripts-yarn3": "^3.0.28",
15
+ "@xylabs/tsconfig": "^3.0.28",
16
16
  "typescript": "^5.2.2"
17
17
  },
18
18
  "docs": "dist/docs.json",
@@ -54,5 +54,5 @@
54
54
  "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js.git"
55
55
  },
56
56
  "sideEffects": false,
57
- "version": "2.74.0"
57
+ "version": "2.74.2"
58
58
  }