@xyo-network/shared 2.42.14 → 2.42.16

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