@dereekb/dbx-components-mcp 13.10.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.
@@ -0,0 +1,1997 @@
1
+ {
2
+ "version": 1,
3
+ "source": "@dereekb/util",
4
+ "topicNamespace": "dereekb-util",
5
+ "generatedAt": "1970-01-01T00:00:00.000Z",
6
+ "generator": "@dereekb/dbx-components-mcp/scripts/generate-manifests.mjs",
7
+ "topics": [],
8
+ "entries": [
9
+ {
10
+ "name": "BooleanTrueChance",
11
+ "package": "@dereekb/util",
12
+ "module": "src/lib/boolean",
13
+ "kind": "semantic-type",
14
+ "definition": "number",
15
+ "baseType": "number",
16
+ "topics": [
17
+ "percent",
18
+ "numeric"
19
+ ],
20
+ "notes": "Number from 0.0 to 100.0 used for the chance to return true.",
21
+ "sourceLocation": {
22
+ "file": "src/lib/boolean.ts",
23
+ "line": 142
24
+ }
25
+ },
26
+ {
27
+ "name": "HashSalt",
28
+ "package": "@dereekb/util",
29
+ "module": "src/lib/hash",
30
+ "kind": "semantic-type",
31
+ "definition": "string",
32
+ "baseType": "string",
33
+ "topics": [
34
+ "string",
35
+ "dereekb-util:hash"
36
+ ],
37
+ "notes": "Represents a salt value used in hashing.",
38
+ "sourceLocation": {
39
+ "file": "src/lib/hash.ts",
40
+ "line": 10
41
+ }
42
+ },
43
+ {
44
+ "name": "SortComparisonNumber",
45
+ "package": "@dereekb/util",
46
+ "module": "src/lib/sort",
47
+ "kind": "semantic-type",
48
+ "definition": "number",
49
+ "baseType": "number",
50
+ "topics": [
51
+ "numeric"
52
+ ],
53
+ "notes": "A number that is the result of comparison two items.\n\nIn \"ascending\" order, a value:\n- smaller than another will return -1 (or less).\n- equal to another will return 0\n- greater than another will return 1 (or more).\n- Example: a - b\n\nIn \"descending\" order, this returns the opposite values as \"ascending\".\n- Example: b - a",
54
+ "sourceLocation": {
55
+ "file": "src/lib/sort.ts",
56
+ "line": 26
57
+ }
58
+ },
59
+ {
60
+ "name": "BooleanStringKey",
61
+ "package": "@dereekb/util",
62
+ "module": "src/lib/array/array.boolean",
63
+ "kind": "semantic-type",
64
+ "definition": "string",
65
+ "baseType": "string",
66
+ "topics": [
67
+ "identifier",
68
+ "string"
69
+ ],
70
+ "notes": "A string type used as a key in boolean arrays.",
71
+ "sourceLocation": {
72
+ "file": "src/lib/array/array.boolean.ts",
73
+ "line": 11
74
+ }
75
+ },
76
+ {
77
+ "name": "RangeInputEndValue",
78
+ "package": "@dereekb/util",
79
+ "module": "src/lib/array/array.number",
80
+ "kind": "semantic-type",
81
+ "definition": "number",
82
+ "baseType": "number",
83
+ "topics": [
84
+ "numeric"
85
+ ],
86
+ "notes": "Exclusive end value used by range().",
87
+ "sourceLocation": {
88
+ "file": "src/lib/array/array.number.ts",
89
+ "line": 99
90
+ }
91
+ },
92
+ {
93
+ "name": "AuthClaimKey",
94
+ "package": "@dereekb/util",
95
+ "module": "src/lib/auth/auth.role.claims",
96
+ "kind": "semantic-type",
97
+ "definition": "string",
98
+ "baseType": "string",
99
+ "topics": [
100
+ "identifier",
101
+ "string",
102
+ "dereekb-util:auth"
103
+ ],
104
+ "notes": "Key in the claims.",
105
+ "sourceLocation": {
106
+ "file": "src/lib/auth/auth.role.claims.ts",
107
+ "line": 17
108
+ }
109
+ },
110
+ {
111
+ "name": "AuthRole",
112
+ "package": "@dereekb/util",
113
+ "module": "src/lib/auth/auth.role",
114
+ "kind": "semantic-type",
115
+ "definition": "string",
116
+ "baseType": "string",
117
+ "topics": [
118
+ "identifier",
119
+ "string",
120
+ "dereekb-util:auth"
121
+ ],
122
+ "notes": "An application role.\n\nIs used in the client to decide which content a user can view.\n\nRoles should always be lowercase.",
123
+ "sourceLocation": {
124
+ "file": "src/lib/auth/auth.role.ts",
125
+ "line": 16
126
+ }
127
+ },
128
+ {
129
+ "name": "EmailAddressDomain",
130
+ "package": "@dereekb/util",
131
+ "module": "src/lib/contact/domain",
132
+ "kind": "semantic-type",
133
+ "definition": "string",
134
+ "baseType": "string",
135
+ "topics": [
136
+ "email",
137
+ "contact",
138
+ "string"
139
+ ],
140
+ "notes": "Domain name portion of an email address (e.g., \"example.com\").",
141
+ "sourceLocation": {
142
+ "file": "src/lib/contact/domain.ts",
143
+ "line": 13
144
+ }
145
+ },
146
+ {
147
+ "name": "EmailAddress",
148
+ "package": "@dereekb/util",
149
+ "module": "src/lib/contact/email",
150
+ "kind": "semantic-type",
151
+ "definition": "string",
152
+ "baseType": "string",
153
+ "topics": [
154
+ "email",
155
+ "contact",
156
+ "string"
157
+ ],
158
+ "notes": "Type representing an email address as a string.",
159
+ "sourceLocation": {
160
+ "file": "src/lib/contact/email.ts",
161
+ "line": 11
162
+ }
163
+ },
164
+ {
165
+ "name": "EmailParticipantString",
166
+ "package": "@dereekb/util",
167
+ "module": "src/lib/contact/email",
168
+ "kind": "semantic-type",
169
+ "definition": "string",
170
+ "baseType": "string",
171
+ "topics": [
172
+ "email",
173
+ "contact",
174
+ "string"
175
+ ],
176
+ "notes": "Email participant string. Starts with the email, followed by the name if available.",
177
+ "sourceLocation": {
178
+ "file": "src/lib/contact/email.ts",
179
+ "line": 35
180
+ }
181
+ },
182
+ {
183
+ "name": "PhoneNumber",
184
+ "package": "@dereekb/util",
185
+ "module": "src/lib/contact/phone",
186
+ "kind": "semantic-type",
187
+ "definition": "string",
188
+ "baseType": "string",
189
+ "topics": [
190
+ "phone",
191
+ "contact",
192
+ "string"
193
+ ],
194
+ "notes": "Phone number string input. No format specified.\n\nExamples:\n- 4567890\n- 123-456-7890\n- (123) 456-7890\n- 1234567890\n- +1234567890\n- +1-555-555-5555\n- 2345678;ext=123",
195
+ "sourceLocation": {
196
+ "file": "src/lib/contact/phone.ts",
197
+ "line": 21
198
+ }
199
+ },
200
+ {
201
+ "name": "PhoneExtensionNumber",
202
+ "package": "@dereekb/util",
203
+ "module": "src/lib/contact/phone",
204
+ "kind": "semantic-type",
205
+ "definition": "string",
206
+ "baseType": "string",
207
+ "topics": [
208
+ "phone",
209
+ "contact",
210
+ "string"
211
+ ],
212
+ "notes": "1-6 digit extension number",
213
+ "sourceLocation": {
214
+ "file": "src/lib/contact/phone.ts",
215
+ "line": 31
216
+ }
217
+ },
218
+ {
219
+ "name": "ReadableTimeString",
220
+ "package": "@dereekb/util",
221
+ "module": "src/lib/date/date.time",
222
+ "kind": "semantic-type",
223
+ "definition": "string",
224
+ "baseType": "string",
225
+ "topics": [
226
+ "time",
227
+ "string"
228
+ ],
229
+ "notes": "Represents a string for a time. This may be human-input, and\ncan be interpreted in various ways depending on the input.\n\nExamples:\n- 1:20AM\n- 1:20\n- 120AM\n- 120",
230
+ "sourceLocation": {
231
+ "file": "src/lib/date/date.time.ts",
232
+ "line": 17
233
+ }
234
+ },
235
+ {
236
+ "name": "RFC3339DateString",
237
+ "package": "@dereekb/util",
238
+ "module": "src/lib/date/date",
239
+ "kind": "semantic-type",
240
+ "definition": "string",
241
+ "baseType": "string",
242
+ "topics": [
243
+ "date",
244
+ "string"
245
+ ],
246
+ "notes": "A valid RFC3339 formatted date string.\n\nI.E. \"2020-04-30 00:00:00.000Z\" and \"2020-04-30T00:00:00.000Z\"\n\nThe only difference between this and an ISO8601DateString is the spacing between the date and time is allowed, while in ISO8601DateString it is not.",
247
+ "sourceLocation": {
248
+ "file": "src/lib/date/date.ts",
249
+ "line": 25
250
+ }
251
+ },
252
+ {
253
+ "name": "ISO8601DateString",
254
+ "package": "@dereekb/util",
255
+ "module": "src/lib/date/date",
256
+ "kind": "semantic-type",
257
+ "definition": "string",
258
+ "baseType": "string",
259
+ "topics": [
260
+ "date",
261
+ "string"
262
+ ],
263
+ "guards": [
264
+ "isISO8601DateString"
265
+ ],
266
+ "notes": "A valid ISO8601 formatted date string.\n\nI.E. \"2020-04-30T00:00:00.000Z\"",
267
+ "sourceLocation": {
268
+ "file": "src/lib/date/date.ts",
269
+ "line": 36
270
+ }
271
+ },
272
+ {
273
+ "name": "UTCDateString",
274
+ "package": "@dereekb/util",
275
+ "module": "src/lib/date/date",
276
+ "kind": "semantic-type",
277
+ "definition": "string",
278
+ "baseType": "string",
279
+ "topics": [
280
+ "date",
281
+ "string"
282
+ ],
283
+ "guards": [
284
+ "isUTCDateString"
285
+ ],
286
+ "notes": "A UTC date string.\n\nI.E. \"Sat, 03 Feb 2001 04:05:06 GMT\"",
287
+ "sourceLocation": {
288
+ "file": "src/lib/date/date.ts",
289
+ "line": 64
290
+ }
291
+ },
292
+ {
293
+ "name": "ISO8601DateStringUTCFull",
294
+ "package": "@dereekb/util",
295
+ "module": "src/lib/date/date",
296
+ "kind": "semantic-type",
297
+ "definition": "string",
298
+ "baseType": "string",
299
+ "topics": [
300
+ "date",
301
+ "string"
302
+ ],
303
+ "notes": "A full ISO8601 date string that is in UTC.\n\nI.E. \"2020-04-30T00:00:00.000Z\"",
304
+ "sourceLocation": {
305
+ "file": "src/lib/date/date.ts",
306
+ "line": 94
307
+ }
308
+ },
309
+ {
310
+ "name": "TimezoneString",
311
+ "package": "@dereekb/util",
312
+ "module": "src/lib/date/date",
313
+ "kind": "semantic-type",
314
+ "definition": "string",
315
+ "baseType": "string",
316
+ "topics": [
317
+ "timezone",
318
+ "string"
319
+ ],
320
+ "notes": "A valid timezone string.\n\nI.E. \"UTC\", \"America/Denver\", etc.",
321
+ "sourceLocation": {
322
+ "file": "src/lib/date/date.ts",
323
+ "line": 105
324
+ }
325
+ },
326
+ {
327
+ "name": "TimezoneAbbreviation",
328
+ "package": "@dereekb/util",
329
+ "module": "src/lib/date/date",
330
+ "kind": "semantic-type",
331
+ "definition": "string",
332
+ "baseType": "string",
333
+ "topics": [
334
+ "timezone",
335
+ "string"
336
+ ],
337
+ "notes": "A timezone abbreviation (UTC, EST, etc).",
338
+ "sourceLocation": {
339
+ "file": "src/lib/date/date.ts",
340
+ "line": 114
341
+ }
342
+ },
343
+ {
344
+ "name": "ISO8601DayString",
345
+ "package": "@dereekb/util",
346
+ "module": "src/lib/date/date",
347
+ "kind": "semantic-type",
348
+ "definition": "string",
349
+ "baseType": "string",
350
+ "topics": [
351
+ "date",
352
+ "string"
353
+ ],
354
+ "guards": [
355
+ "isISO8601DayString"
356
+ ],
357
+ "notes": "A full date string Formatted as ISO8601 with 4 digits for the year.\n\nYear, Month, Day\n\nI.E. 1921-06-23\n\nNOTE: Negative years and years with more than 4 digits are not supported/expected. Support can be added later, but will require adding a more complex regex, and improved parsing in",
358
+ "sourceLocation": {
359
+ "file": "src/lib/date/date.ts",
360
+ "line": 180
361
+ }
362
+ },
363
+ {
364
+ "name": "MonthDaySlashDate",
365
+ "package": "@dereekb/util",
366
+ "module": "src/lib/date/date",
367
+ "kind": "semantic-type",
368
+ "definition": "string",
369
+ "baseType": "string",
370
+ "topics": [
371
+ "date",
372
+ "string"
373
+ ],
374
+ "guards": [
375
+ "isMonthDaySlashDate"
376
+ ],
377
+ "notes": "Date that is represented by slashes. Is considered in the Month/Day/Year format.",
378
+ "sourceLocation": {
379
+ "file": "src/lib/date/date.ts",
380
+ "line": 258
381
+ }
382
+ },
383
+ {
384
+ "name": "UnixDateTimeMillisecondsNumber",
385
+ "package": "@dereekb/util",
386
+ "module": "src/lib/date/date",
387
+ "kind": "semantic-type",
388
+ "definition": "number",
389
+ "baseType": "number",
390
+ "topics": [
391
+ "time",
392
+ "numeric"
393
+ ],
394
+ "notes": "Time in milliseconds since the epoch.\n\nReturned by Date.getTime().",
395
+ "sourceLocation": {
396
+ "file": "src/lib/date/date.ts",
397
+ "line": 310
398
+ }
399
+ },
400
+ {
401
+ "name": "Milliseconds",
402
+ "package": "@dereekb/util",
403
+ "module": "src/lib/date/date",
404
+ "kind": "semantic-type",
405
+ "definition": "number",
406
+ "baseType": "number",
407
+ "topics": [
408
+ "time",
409
+ "duration",
410
+ "numeric"
411
+ ],
412
+ "notes": "Number of milliseconds.",
413
+ "sourceLocation": {
414
+ "file": "src/lib/date/date.ts",
415
+ "line": 358
416
+ }
417
+ },
418
+ {
419
+ "name": "Seconds",
420
+ "package": "@dereekb/util",
421
+ "module": "src/lib/date/date",
422
+ "kind": "semantic-type",
423
+ "definition": "number",
424
+ "baseType": "number",
425
+ "topics": [
426
+ "time",
427
+ "duration",
428
+ "numeric"
429
+ ],
430
+ "notes": "Number of seconds.",
431
+ "sourceLocation": {
432
+ "file": "src/lib/date/date.ts",
433
+ "line": 388
434
+ }
435
+ },
436
+ {
437
+ "name": "Minutes",
438
+ "package": "@dereekb/util",
439
+ "module": "src/lib/date/date",
440
+ "kind": "semantic-type",
441
+ "definition": "number",
442
+ "baseType": "number",
443
+ "topics": [
444
+ "time",
445
+ "duration",
446
+ "numeric"
447
+ ],
448
+ "notes": "Number of minutes.",
449
+ "sourceLocation": {
450
+ "file": "src/lib/date/date.ts",
451
+ "line": 398
452
+ }
453
+ },
454
+ {
455
+ "name": "Hours",
456
+ "package": "@dereekb/util",
457
+ "module": "src/lib/date/date",
458
+ "kind": "semantic-type",
459
+ "definition": "number",
460
+ "baseType": "number",
461
+ "topics": [
462
+ "time",
463
+ "duration",
464
+ "numeric"
465
+ ],
466
+ "notes": "Number of hours.",
467
+ "sourceLocation": {
468
+ "file": "src/lib/date/date.ts",
469
+ "line": 408
470
+ }
471
+ },
472
+ {
473
+ "name": "Days",
474
+ "package": "@dereekb/util",
475
+ "module": "src/lib/date/date",
476
+ "kind": "semantic-type",
477
+ "definition": "number",
478
+ "baseType": "number",
479
+ "topics": [
480
+ "time",
481
+ "duration",
482
+ "numeric"
483
+ ],
484
+ "notes": "Number of days.",
485
+ "sourceLocation": {
486
+ "file": "src/lib/date/date.ts",
487
+ "line": 418
488
+ }
489
+ },
490
+ {
491
+ "name": "DayOfMonth",
492
+ "package": "@dereekb/util",
493
+ "module": "src/lib/date/date",
494
+ "kind": "semantic-type",
495
+ "definition": "number",
496
+ "baseType": "number",
497
+ "topics": [
498
+ "date",
499
+ "numeric"
500
+ ],
501
+ "notes": "Day of the month, 1-31",
502
+ "sourceLocation": {
503
+ "file": "src/lib/date/date.ts",
504
+ "line": 487
505
+ }
506
+ },
507
+ {
508
+ "name": "MonthOfYear",
509
+ "package": "@dereekb/util",
510
+ "module": "src/lib/date/date",
511
+ "kind": "semantic-type",
512
+ "definition": "number",
513
+ "baseType": "number",
514
+ "topics": [
515
+ "date",
516
+ "numeric"
517
+ ],
518
+ "notes": "Month of the year, 1-12.\n\nNOTE: The month from Date.getMonth() is from 0-11. Use monthOfYearFromDate() to get the MonthOfYear value.",
519
+ "sourceLocation": {
520
+ "file": "src/lib/date/date.ts",
521
+ "line": 498
522
+ }
523
+ },
524
+ {
525
+ "name": "DateMonth",
526
+ "package": "@dereekb/util",
527
+ "module": "src/lib/date/date",
528
+ "kind": "semantic-type",
529
+ "definition": "number",
530
+ "baseType": "number",
531
+ "topics": [
532
+ "date",
533
+ "numeric"
534
+ ],
535
+ "notes": "Javascript Date month number. 0-11.",
536
+ "sourceLocation": {
537
+ "file": "src/lib/date/date.ts",
538
+ "line": 507
539
+ }
540
+ },
541
+ {
542
+ "name": "YearNumber",
543
+ "package": "@dereekb/util",
544
+ "module": "src/lib/date/date",
545
+ "kind": "semantic-type",
546
+ "definition": "number",
547
+ "baseType": "number",
548
+ "topics": [
549
+ "date",
550
+ "numeric"
551
+ ],
552
+ "notes": "Year number. I.E. 2022",
553
+ "sourceLocation": {
554
+ "file": "src/lib/date/date.ts",
555
+ "line": 560
556
+ }
557
+ },
558
+ {
559
+ "name": "UnixDateTimeSecondsNumber",
560
+ "package": "@dereekb/util",
561
+ "module": "src/lib/date/date.unix",
562
+ "kind": "semantic-type",
563
+ "definition": "number",
564
+ "baseType": "number",
565
+ "topics": [
566
+ "time",
567
+ "numeric"
568
+ ],
569
+ "notes": "This value is in seconds since the Epoch.\n\nUse UnixDateTimeMillisecondsNumber instead if you need milliseconds.",
570
+ "sourceLocation": {
571
+ "file": "src/lib/date/date.unix.ts",
572
+ "line": 13
573
+ }
574
+ },
575
+ {
576
+ "name": "FractionalHour",
577
+ "package": "@dereekb/util",
578
+ "module": "src/lib/date/hour",
579
+ "kind": "semantic-type",
580
+ "definition": "number",
581
+ "baseType": "number",
582
+ "topics": [
583
+ "date",
584
+ "numeric"
585
+ ],
586
+ "notes": "A number that represents hours and rounded to the nearest minute.\n\nIt has only three decimal places max.\n\nFractional hours are safe to add together.\n\nFor example:\n\n- 10 minutes: 0.16\n- 15 minutes : 0.25",
587
+ "sourceLocation": {
588
+ "file": "src/lib/date/hour.ts",
589
+ "line": 21
590
+ }
591
+ },
592
+ {
593
+ "name": "MinuteOfDay",
594
+ "package": "@dereekb/util",
595
+ "module": "src/lib/date/hour",
596
+ "kind": "semantic-type",
597
+ "definition": "number",
598
+ "baseType": "number",
599
+ "topics": [
600
+ "date",
601
+ "numeric"
602
+ ],
603
+ "guards": [
604
+ "isMinuteOfDay"
605
+ ],
606
+ "notes": "The minute of the day.\n\nNumber from 0-1439.",
607
+ "sourceLocation": {
608
+ "file": "src/lib/date/hour.ts",
609
+ "line": 98
610
+ }
611
+ },
612
+ {
613
+ "name": "EncryptedString",
614
+ "package": "@dereekb/util",
615
+ "module": "src/lib/encryption/encryption.object",
616
+ "kind": "semantic-type",
617
+ "definition": "string",
618
+ "baseType": "string",
619
+ "topics": [
620
+ "string",
621
+ "dereekb-util:encryption"
622
+ ],
623
+ "notes": "Branded type representing a string that has been encrypted.\n\nUse this type to distinguish encrypted ciphertext from plain strings at the type level.\nThe actual encryption algorithm is determined by the {@link StringEncryptionProvider}.",
624
+ "sourceLocation": {
625
+ "file": "src/lib/encryption/encryption.object.ts",
626
+ "line": 14
627
+ }
628
+ },
629
+ {
630
+ "name": "StringErrorCode",
631
+ "package": "@dereekb/util",
632
+ "module": "src/lib/error/error",
633
+ "kind": "semantic-type",
634
+ "definition": "string",
635
+ "baseType": "string",
636
+ "topics": [
637
+ "identifier",
638
+ "string"
639
+ ],
640
+ "notes": "A unique identifier for a specific error.",
641
+ "sourceLocation": {
642
+ "file": "src/lib/error/error.ts",
643
+ "line": 17
644
+ }
645
+ },
646
+ {
647
+ "name": "FileSize",
648
+ "package": "@dereekb/util",
649
+ "module": "src/lib/file/file",
650
+ "kind": "semantic-type",
651
+ "definition": "number",
652
+ "baseType": "number",
653
+ "topics": [
654
+ "measurement",
655
+ "numeric"
656
+ ],
657
+ "notes": "File size in bytes.",
658
+ "sourceLocation": {
659
+ "file": "src/lib/file/file.ts",
660
+ "line": 8
661
+ }
662
+ },
663
+ {
664
+ "name": "XMLSVG",
665
+ "package": "@dereekb/util",
666
+ "module": "src/lib/file/xml",
667
+ "kind": "semantic-type",
668
+ "definition": "string",
669
+ "baseType": "string",
670
+ "topics": [
671
+ "string",
672
+ "dereekb-util:xml"
673
+ ],
674
+ "notes": "String value containing an XML SVG string.",
675
+ "sourceLocation": {
676
+ "file": "src/lib/file/xml.ts",
677
+ "line": 8
678
+ }
679
+ },
680
+ {
681
+ "name": "ModelKey",
682
+ "package": "@dereekb/util",
683
+ "module": "src/lib/model/model",
684
+ "kind": "semantic-type",
685
+ "definition": "string",
686
+ "baseType": "string",
687
+ "topics": [
688
+ "identifier",
689
+ "string"
690
+ ],
691
+ "guards": [
692
+ "isModelKey"
693
+ ],
694
+ "notes": "A string model key",
695
+ "sourceLocation": {
696
+ "file": "src/lib/model/model.ts",
697
+ "line": 14
698
+ }
699
+ },
700
+ {
701
+ "name": "ModelId",
702
+ "package": "@dereekb/util",
703
+ "module": "src/lib/model/model",
704
+ "kind": "semantic-type",
705
+ "definition": "string",
706
+ "baseType": "string",
707
+ "topics": [
708
+ "identifier",
709
+ "string"
710
+ ],
711
+ "notes": "A string model identifier (typically the document/record ID segment, not the full path).",
712
+ "sourceLocation": {
713
+ "file": "src/lib/model/model.ts",
714
+ "line": 23
715
+ }
716
+ },
717
+ {
718
+ "name": "ModelTypeString",
719
+ "package": "@dereekb/util",
720
+ "module": "src/lib/model/model",
721
+ "kind": "semantic-type",
722
+ "definition": "string",
723
+ "baseType": "string",
724
+ "topics": [
725
+ "identifier",
726
+ "string"
727
+ ],
728
+ "notes": "Arbitrary model type.",
729
+ "sourceLocation": {
730
+ "file": "src/lib/model/model.ts",
731
+ "line": 32
732
+ }
733
+ },
734
+ {
735
+ "name": "TypedModelKey",
736
+ "package": "@dereekb/util",
737
+ "module": "src/lib/model/model",
738
+ "kind": "semantic-type",
739
+ "definition": "string",
740
+ "baseType": "string",
741
+ "topics": [
742
+ "identifier",
743
+ "string"
744
+ ],
745
+ "notes": "String model key from which the model's type can be inferred from.",
746
+ "sourceLocation": {
747
+ "file": "src/lib/model/model.ts",
748
+ "line": 41
749
+ }
750
+ },
751
+ {
752
+ "name": "ModelKeyTypePairString",
753
+ "package": "@dereekb/util",
754
+ "module": "src/lib/model/model",
755
+ "kind": "semantic-type",
756
+ "definition": "string",
757
+ "baseType": "string",
758
+ "topics": [
759
+ "identifier",
760
+ "string"
761
+ ],
762
+ "notes": "An encoded ModelKeyTypePair.",
763
+ "sourceLocation": {
764
+ "file": "src/lib/model/model.ts",
765
+ "line": 86
766
+ }
767
+ },
768
+ {
769
+ "name": "BitwiseEncodedSetIndex",
770
+ "package": "@dereekb/util",
771
+ "module": "src/lib/number/bitwise.dencoder",
772
+ "kind": "semantic-type",
773
+ "definition": "number",
774
+ "baseType": "number",
775
+ "topics": [
776
+ "numeric",
777
+ "dereekb-util:encoding"
778
+ ],
779
+ "notes": "Enum or number value from 0 to 31 that denotes a specific item via index of the bit to measure.",
780
+ "sourceLocation": {
781
+ "file": "src/lib/number/bitwise.dencoder.ts",
782
+ "line": 19
783
+ }
784
+ },
785
+ {
786
+ "name": "BitwiseEncodedSet",
787
+ "package": "@dereekb/util",
788
+ "module": "src/lib/number/bitwise.dencoder",
789
+ "kind": "semantic-type",
790
+ "definition": "number",
791
+ "baseType": "number",
792
+ "topics": [
793
+ "numeric",
794
+ "dereekb-util:encoding"
795
+ ],
796
+ "notes": "Set of values that are encoded into a single number.\n\nThe number can include up to 32 unique boolean values.",
797
+ "sourceLocation": {
798
+ "file": "src/lib/number/bitwise.dencoder.ts",
799
+ "line": 30
800
+ }
801
+ },
802
+ {
803
+ "name": "WholeDollarAmount",
804
+ "package": "@dereekb/util",
805
+ "module": "src/lib/number/dollar",
806
+ "kind": "semantic-type",
807
+ "definition": "number",
808
+ "baseType": "number",
809
+ "topics": [
810
+ "currency",
811
+ "numeric"
812
+ ],
813
+ "notes": "Whole dollar amounts, before the ','.",
814
+ "sourceLocation": {
815
+ "file": "src/lib/number/dollar.ts",
816
+ "line": 11
817
+ }
818
+ },
819
+ {
820
+ "name": "DollarAmount",
821
+ "package": "@dereekb/util",
822
+ "module": "src/lib/number/dollar",
823
+ "kind": "semantic-type",
824
+ "definition": "number",
825
+ "baseType": "number",
826
+ "topics": [
827
+ "currency",
828
+ "numeric"
829
+ ],
830
+ "notes": "Dollar amount number.",
831
+ "sourceLocation": {
832
+ "file": "src/lib/number/dollar.ts",
833
+ "line": 20
834
+ }
835
+ },
836
+ {
837
+ "name": "DollarAmountPerHour",
838
+ "package": "@dereekb/util",
839
+ "module": "src/lib/number/dollar",
840
+ "kind": "semantic-type",
841
+ "definition": "number",
842
+ "baseType": "number",
843
+ "topics": [
844
+ "currency",
845
+ "numeric"
846
+ ],
847
+ "notes": "Dollars amount number per hour.",
848
+ "sourceLocation": {
849
+ "file": "src/lib/number/dollar.ts",
850
+ "line": 29
851
+ }
852
+ },
853
+ {
854
+ "name": "DollarAmountPerDay",
855
+ "package": "@dereekb/util",
856
+ "module": "src/lib/number/dollar",
857
+ "kind": "semantic-type",
858
+ "definition": "number",
859
+ "baseType": "number",
860
+ "topics": [
861
+ "currency",
862
+ "numeric"
863
+ ],
864
+ "notes": "Dollars amount number per day.",
865
+ "sourceLocation": {
866
+ "file": "src/lib/number/dollar.ts",
867
+ "line": 38
868
+ }
869
+ },
870
+ {
871
+ "name": "CentsAmount",
872
+ "package": "@dereekb/util",
873
+ "module": "src/lib/number/dollar",
874
+ "kind": "semantic-type",
875
+ "definition": "number",
876
+ "baseType": "number",
877
+ "topics": [
878
+ "currency",
879
+ "numeric"
880
+ ],
881
+ "notes": "Amount in whole cents.",
882
+ "sourceLocation": {
883
+ "file": "src/lib/number/dollar.ts",
884
+ "line": 47
885
+ }
886
+ },
887
+ {
888
+ "name": "DollarAmountUnit",
889
+ "package": "@dereekb/util",
890
+ "module": "src/lib/number/dollar",
891
+ "kind": "semantic-type",
892
+ "definition": "string",
893
+ "baseType": "string",
894
+ "topics": [
895
+ "currency",
896
+ "string"
897
+ ],
898
+ "notes": "Unit to affix to a dollar amount string.",
899
+ "sourceLocation": {
900
+ "file": "src/lib/number/dollar.ts",
901
+ "line": 61
902
+ }
903
+ },
904
+ {
905
+ "name": "DollarAmountString",
906
+ "package": "@dereekb/util",
907
+ "module": "src/lib/number/dollar",
908
+ "kind": "semantic-type",
909
+ "definition": "string",
910
+ "baseType": "string",
911
+ "topics": [
912
+ "currency",
913
+ "string"
914
+ ],
915
+ "guards": [
916
+ "isDollarAmountString"
917
+ ],
918
+ "notes": "String representing a dollar amount.\n\nIs formatted as a number with two decimal places. No unit is affixed.",
919
+ "sourceLocation": {
920
+ "file": "src/lib/number/dollar.ts",
921
+ "line": 72
922
+ }
923
+ },
924
+ {
925
+ "name": "Radix36EncodedNumber",
926
+ "package": "@dereekb/util",
927
+ "module": "src/lib/number/encoded",
928
+ "kind": "semantic-type",
929
+ "definition": "string",
930
+ "baseType": "string",
931
+ "topics": [
932
+ "string",
933
+ "dereekb-util:encoding"
934
+ ],
935
+ "examples": [
936
+ {
937
+ "code": "const encoded: Radix36EncodedNumber = 'z'; // represents 35\nconst largeEncoded: Radix36EncodedNumber = '2s'; // represents 100"
938
+ }
939
+ ],
940
+ "notes": "A number encoded as a radix-36 string using digits 0-9 and letters a-z.\n\nRadix-36 encoding produces compact string representations of numbers,\nuseful for URL-safe identifiers and short codes.",
941
+ "sourceLocation": {
942
+ "file": "src/lib/number/encoded.ts",
943
+ "line": 17
944
+ }
945
+ },
946
+ {
947
+ "name": "HexString",
948
+ "package": "@dereekb/util",
949
+ "module": "src/lib/number/encoded",
950
+ "kind": "semantic-type",
951
+ "definition": "string",
952
+ "baseType": "string",
953
+ "topics": [
954
+ "string",
955
+ "dereekb-util:encoding"
956
+ ],
957
+ "notes": "A string containing only hexadecimal characters (0-9, a-f or A-F).",
958
+ "sourceLocation": {
959
+ "file": "src/lib/number/encoded.ts",
960
+ "line": 67
961
+ }
962
+ },
963
+ {
964
+ "name": "Count",
965
+ "package": "@dereekb/util",
966
+ "module": "src/lib/number/number",
967
+ "kind": "semantic-type",
968
+ "definition": "number",
969
+ "baseType": "number",
970
+ "topics": [
971
+ "numeric"
972
+ ],
973
+ "examples": [
974
+ {
975
+ "code": "const totalUsers: Count = 42;"
976
+ }
977
+ ],
978
+ "notes": "A non-negative integer representing a count of items.",
979
+ "sourceLocation": {
980
+ "file": "src/lib/number/number.ts",
981
+ "line": 16
982
+ }
983
+ },
984
+ {
985
+ "name": "NumberString",
986
+ "package": "@dereekb/util",
987
+ "module": "src/lib/number/number",
988
+ "kind": "semantic-type",
989
+ "definition": "string",
990
+ "baseType": "string",
991
+ "topics": [
992
+ "numeric",
993
+ "string"
994
+ ],
995
+ "notes": "A string represented within a number.",
996
+ "sourceLocation": {
997
+ "file": "src/lib/number/number.ts",
998
+ "line": 25
999
+ }
1000
+ },
1001
+ {
1002
+ "name": "PercentNumber",
1003
+ "package": "@dereekb/util",
1004
+ "module": "src/lib/number/number",
1005
+ "kind": "semantic-type",
1006
+ "definition": "number",
1007
+ "baseType": "number",
1008
+ "topics": [
1009
+ "percent",
1010
+ "numeric"
1011
+ ],
1012
+ "notes": "Number that represents a percent.\n\n e.g. PercentNumber of 5 = 0.05 = 5%",
1013
+ "sourceLocation": {
1014
+ "file": "src/lib/number/number.ts",
1015
+ "line": 36
1016
+ }
1017
+ },
1018
+ {
1019
+ "name": "PercentDecimal",
1020
+ "package": "@dereekb/util",
1021
+ "module": "src/lib/number/number",
1022
+ "kind": "semantic-type",
1023
+ "definition": "number",
1024
+ "baseType": "number",
1025
+ "topics": [
1026
+ "percent",
1027
+ "numeric"
1028
+ ],
1029
+ "notes": "A percent decimal value.\n\ne.g. PercentDecimal of 0.05 = 5%",
1030
+ "sourceLocation": {
1031
+ "file": "src/lib/number/number.ts",
1032
+ "line": 47
1033
+ }
1034
+ },
1035
+ {
1036
+ "name": "PayRate",
1037
+ "package": "@dereekb/util",
1038
+ "module": "src/lib/number/pay",
1039
+ "kind": "semantic-type",
1040
+ "definition": "number",
1041
+ "baseType": "number",
1042
+ "topics": [
1043
+ "currency",
1044
+ "numeric"
1045
+ ],
1046
+ "notes": "Rate per hour the worker should be paid.",
1047
+ "sourceLocation": {
1048
+ "file": "src/lib/number/pay.ts",
1049
+ "line": 8
1050
+ }
1051
+ },
1052
+ {
1053
+ "name": "PayAmount",
1054
+ "package": "@dereekb/util",
1055
+ "module": "src/lib/number/pay",
1056
+ "kind": "semantic-type",
1057
+ "definition": "number",
1058
+ "baseType": "number",
1059
+ "topics": [
1060
+ "currency",
1061
+ "numeric"
1062
+ ],
1063
+ "notes": "The total pay amount that should be paid.",
1064
+ "sourceLocation": {
1065
+ "file": "src/lib/number/pay.ts",
1066
+ "line": 17
1067
+ }
1068
+ },
1069
+ {
1070
+ "name": "NumberPrecision",
1071
+ "package": "@dereekb/util",
1072
+ "module": "src/lib/number/round",
1073
+ "kind": "semantic-type",
1074
+ "definition": "number",
1075
+ "baseType": "number",
1076
+ "topics": [
1077
+ "numeric",
1078
+ "measurement"
1079
+ ],
1080
+ "notes": "The number of decimal places ot use.",
1081
+ "sourceLocation": {
1082
+ "file": "src/lib/number/round.ts",
1083
+ "line": 49
1084
+ }
1085
+ },
1086
+ {
1087
+ "name": "StepNumber",
1088
+ "package": "@dereekb/util",
1089
+ "module": "src/lib/number/round",
1090
+ "kind": "semantic-type",
1091
+ "definition": "number",
1092
+ "baseType": "number",
1093
+ "topics": [
1094
+ "numeric"
1095
+ ],
1096
+ "notes": "Number used to increase or decrease by the \"step\" value. When used in rounding the steps are aligned at a StepOrigin.",
1097
+ "sourceLocation": {
1098
+ "file": "src/lib/number/round.ts",
1099
+ "line": 168
1100
+ }
1101
+ },
1102
+ {
1103
+ "name": "StepOrigin",
1104
+ "package": "@dereekb/util",
1105
+ "module": "src/lib/number/round",
1106
+ "kind": "semantic-type",
1107
+ "definition": "number",
1108
+ "baseType": "number",
1109
+ "topics": [
1110
+ "numeric"
1111
+ ],
1112
+ "notes": "Origin value for StepNumbers that is used as an offset for input. Is usually 0.",
1113
+ "sourceLocation": {
1114
+ "file": "src/lib/number/round.ts",
1115
+ "line": 176
1116
+ }
1117
+ },
1118
+ {
1119
+ "name": "ObjectKey",
1120
+ "package": "@dereekb/util",
1121
+ "module": "src/lib/object/object",
1122
+ "kind": "semantic-type",
1123
+ "definition": "string",
1124
+ "baseType": "string",
1125
+ "topics": [
1126
+ "identifier",
1127
+ "string"
1128
+ ],
1129
+ "notes": "String key of an object.",
1130
+ "sourceLocation": {
1131
+ "file": "src/lib/object/object.ts",
1132
+ "line": 23
1133
+ }
1134
+ },
1135
+ {
1136
+ "name": "PageNumber",
1137
+ "package": "@dereekb/util",
1138
+ "module": "src/lib/page/page",
1139
+ "kind": "semantic-type",
1140
+ "definition": "number",
1141
+ "baseType": "number",
1142
+ "topics": [
1143
+ "numeric",
1144
+ "reference",
1145
+ "dereekb-util:pagination"
1146
+ ],
1147
+ "notes": "Numeric page identifier.",
1148
+ "sourceLocation": {
1149
+ "file": "src/lib/page/page.ts",
1150
+ "line": 26
1151
+ }
1152
+ },
1153
+ {
1154
+ "name": "SlashPathTypedFileExtension",
1155
+ "package": "@dereekb/util",
1156
+ "module": "src/lib/path/path",
1157
+ "kind": "semantic-type",
1158
+ "definition": "string",
1159
+ "baseType": "string",
1160
+ "topics": [
1161
+ "string",
1162
+ "dereekb-util:path"
1163
+ ],
1164
+ "notes": "The file extension of a SlashPathTypedFile.\n\ne.g. 'png' in 'image.png'",
1165
+ "sourceLocation": {
1166
+ "file": "src/lib/path/path.ts",
1167
+ "line": 60
1168
+ }
1169
+ },
1170
+ {
1171
+ "name": "SlashPathUntypedFile",
1172
+ "package": "@dereekb/util",
1173
+ "module": "src/lib/path/path",
1174
+ "kind": "semantic-type",
1175
+ "definition": "string",
1176
+ "baseType": "string",
1177
+ "topics": [
1178
+ "string",
1179
+ "dereekb-util:path"
1180
+ ],
1181
+ "notes": "A SlashPath file name without a file type identifier (e.g. 'image', and not 'image.png')",
1182
+ "sourceLocation": {
1183
+ "file": "src/lib/path/path.ts",
1184
+ "line": 76
1185
+ }
1186
+ },
1187
+ {
1188
+ "name": "PerformTasksInParallelTaskUniqueKey",
1189
+ "package": "@dereekb/util",
1190
+ "module": "src/lib/promise/promise",
1191
+ "kind": "semantic-type",
1192
+ "definition": "string",
1193
+ "baseType": "string",
1194
+ "topics": [
1195
+ "identifier",
1196
+ "string",
1197
+ "dereekb-util:concurrency"
1198
+ ],
1199
+ "notes": "Used as a key to identify the \"group\" that a task belongs to to prevent other concurrent tasks from that group from running in parallel when parallel execution is desired.",
1200
+ "sourceLocation": {
1201
+ "file": "src/lib/promise/promise.ts",
1202
+ "line": 257
1203
+ }
1204
+ },
1205
+ {
1206
+ "name": "RelationString",
1207
+ "package": "@dereekb/util",
1208
+ "module": "src/lib/relation/relation",
1209
+ "kind": "semantic-type",
1210
+ "definition": "string",
1211
+ "baseType": "string",
1212
+ "topics": [
1213
+ "identifier",
1214
+ "string",
1215
+ "dereekb-util:relation"
1216
+ ],
1217
+ "notes": "A string-based relation identifier.",
1218
+ "sourceLocation": {
1219
+ "file": "src/lib/relation/relation.ts",
1220
+ "line": 54
1221
+ }
1222
+ },
1223
+ {
1224
+ "name": "RelationModelType",
1225
+ "package": "@dereekb/util",
1226
+ "module": "src/lib/relation/relation",
1227
+ "kind": "semantic-type",
1228
+ "definition": "string",
1229
+ "baseType": "string",
1230
+ "topics": [
1231
+ "identifier",
1232
+ "string",
1233
+ "dereekb-util:relation"
1234
+ ],
1235
+ "notes": "A string identifying the type/category of a relation model.",
1236
+ "sourceLocation": {
1237
+ "file": "src/lib/relation/relation.ts",
1238
+ "line": 69
1239
+ }
1240
+ },
1241
+ {
1242
+ "name": "StoredDataString",
1243
+ "package": "@dereekb/util",
1244
+ "module": "src/lib/storage/storage",
1245
+ "kind": "semantic-type",
1246
+ "definition": "string",
1247
+ "baseType": "string",
1248
+ "topics": [
1249
+ "string",
1250
+ "reference"
1251
+ ],
1252
+ "notes": "String representation of data that is stored.",
1253
+ "sourceLocation": {
1254
+ "file": "src/lib/storage/storage.ts",
1255
+ "line": 10
1256
+ }
1257
+ },
1258
+ {
1259
+ "name": "StoredDataStorageKey",
1260
+ "package": "@dereekb/util",
1261
+ "module": "src/lib/storage/storage",
1262
+ "kind": "semantic-type",
1263
+ "definition": "string",
1264
+ "baseType": "string",
1265
+ "topics": [
1266
+ "identifier",
1267
+ "string",
1268
+ "reference"
1269
+ ],
1270
+ "notes": "Key used for accessing stored data.",
1271
+ "sourceLocation": {
1272
+ "file": "src/lib/storage/storage.ts",
1273
+ "line": 19
1274
+ }
1275
+ },
1276
+ {
1277
+ "name": "NumberStringDencoderNumber",
1278
+ "package": "@dereekb/util",
1279
+ "module": "src/lib/string/dencoder",
1280
+ "kind": "semantic-type",
1281
+ "definition": "number",
1282
+ "baseType": "number",
1283
+ "topics": [
1284
+ "numeric",
1285
+ "dereekb-util:encoding"
1286
+ ],
1287
+ "notes": "An encodable number. This is typically a positive integer value.",
1288
+ "sourceLocation": {
1289
+ "file": "src/lib/string/dencoder.ts",
1290
+ "line": 224
1291
+ }
1292
+ },
1293
+ {
1294
+ "name": "NumberStringDencoderString",
1295
+ "package": "@dereekb/util",
1296
+ "module": "src/lib/string/dencoder",
1297
+ "kind": "semantic-type",
1298
+ "definition": "string",
1299
+ "baseType": "string",
1300
+ "topics": [
1301
+ "string",
1302
+ "dereekb-util:encoding"
1303
+ ],
1304
+ "notes": "A number-encoded string. Little-Endian. Should Decode to the same value each time.",
1305
+ "sourceLocation": {
1306
+ "file": "src/lib/string/dencoder.ts",
1307
+ "line": 233
1308
+ }
1309
+ },
1310
+ {
1311
+ "name": "NumberStringDencoderDigits",
1312
+ "package": "@dereekb/util",
1313
+ "module": "src/lib/string/dencoder",
1314
+ "kind": "semantic-type",
1315
+ "definition": "string",
1316
+ "baseType": "string",
1317
+ "topics": [
1318
+ "string",
1319
+ "dereekb-util:encoding"
1320
+ ],
1321
+ "notes": "Digits used when encoding/decoding a value.\n\nThe number of digits/characters must be a factor of 2. I.E. 8, 16, 32, 64",
1322
+ "sourceLocation": {
1323
+ "file": "src/lib/string/dencoder.ts",
1324
+ "line": 244
1325
+ }
1326
+ },
1327
+ {
1328
+ "name": "CssClass",
1329
+ "package": "@dereekb/util",
1330
+ "module": "src/lib/string/html",
1331
+ "kind": "semantic-type",
1332
+ "definition": "string",
1333
+ "baseType": "string",
1334
+ "topics": [
1335
+ "string",
1336
+ "dereekb-util:css"
1337
+ ],
1338
+ "notes": "Represents a single CSS Class",
1339
+ "sourceLocation": {
1340
+ "file": "src/lib/string/html.ts",
1341
+ "line": 21
1342
+ }
1343
+ },
1344
+ {
1345
+ "name": "CssTokenName",
1346
+ "package": "@dereekb/util",
1347
+ "module": "src/lib/string/html",
1348
+ "kind": "semantic-type",
1349
+ "definition": "string",
1350
+ "baseType": "string",
1351
+ "topics": [
1352
+ "string",
1353
+ "dereekb-util:css"
1354
+ ],
1355
+ "examples": [
1356
+ {
1357
+ "code": "const name: CssTokenName = 'dbx-primary-color';"
1358
+ }
1359
+ ],
1360
+ "notes": "The name portion of a CSS token, without the leading `--` prefix.",
1361
+ "sourceLocation": {
1362
+ "file": "src/lib/string/html.ts",
1363
+ "line": 35
1364
+ }
1365
+ },
1366
+ {
1367
+ "name": "CssStyle",
1368
+ "package": "@dereekb/util",
1369
+ "module": "src/lib/string/html",
1370
+ "kind": "semantic-type",
1371
+ "definition": "string",
1372
+ "baseType": "string",
1373
+ "topics": [
1374
+ "string",
1375
+ "dereekb-util:css"
1376
+ ],
1377
+ "notes": "Represents a single CSS Style",
1378
+ "sourceLocation": {
1379
+ "file": "src/lib/string/html.ts",
1380
+ "line": 95
1381
+ }
1382
+ },
1383
+ {
1384
+ "name": "SpaceSeparatedCssClasses",
1385
+ "package": "@dereekb/util",
1386
+ "module": "src/lib/string/html",
1387
+ "kind": "semantic-type",
1388
+ "definition": "string",
1389
+ "baseType": "string",
1390
+ "topics": [
1391
+ "string",
1392
+ "dereekb-util:css"
1393
+ ],
1394
+ "notes": "Represents one or more CssClasses that are space separated.",
1395
+ "sourceLocation": {
1396
+ "file": "src/lib/string/html.ts",
1397
+ "line": 104
1398
+ }
1399
+ },
1400
+ {
1401
+ "name": "SpaceSeparatedCssStyles",
1402
+ "package": "@dereekb/util",
1403
+ "module": "src/lib/string/html",
1404
+ "kind": "semantic-type",
1405
+ "definition": "string",
1406
+ "baseType": "string",
1407
+ "topics": [
1408
+ "string",
1409
+ "dereekb-util:css"
1410
+ ],
1411
+ "notes": "Represents one or more CssStyles that are space separated.",
1412
+ "sourceLocation": {
1413
+ "file": "src/lib/string/html.ts",
1414
+ "line": 118
1415
+ }
1416
+ },
1417
+ {
1418
+ "name": "JSONEncodedString",
1419
+ "package": "@dereekb/util",
1420
+ "module": "src/lib/string/json",
1421
+ "kind": "semantic-type",
1422
+ "definition": "string",
1423
+ "baseType": "string",
1424
+ "topics": [
1425
+ "string",
1426
+ "dereekb-util:encoding"
1427
+ ],
1428
+ "notes": "A json encoded string.",
1429
+ "sourceLocation": {
1430
+ "file": "src/lib/string/json.ts",
1431
+ "line": 8
1432
+ }
1433
+ },
1434
+ {
1435
+ "name": "MimeTypeWithoutParameters",
1436
+ "package": "@dereekb/util",
1437
+ "module": "src/lib/string/mimetype",
1438
+ "kind": "semantic-type",
1439
+ "definition": "string",
1440
+ "baseType": "string",
1441
+ "topics": [
1442
+ "string",
1443
+ "dereekb-util:mime"
1444
+ ],
1445
+ "notes": "A simple mime type string with just the type/subtype and no parameters.\n\nI.E. \"application/json\"",
1446
+ "sourceLocation": {
1447
+ "file": "src/lib/string/mimetype.ts",
1448
+ "line": 14
1449
+ }
1450
+ },
1451
+ {
1452
+ "name": "MimeTypeWithSubtypeWildcardWithoutParameters",
1453
+ "package": "@dereekb/util",
1454
+ "module": "src/lib/string/mimetype",
1455
+ "kind": "semantic-type",
1456
+ "definition": "string",
1457
+ "baseType": "string",
1458
+ "topics": [
1459
+ "string",
1460
+ "dereekb-util:mime"
1461
+ ],
1462
+ "notes": "A mime type with a wildcard subtype. Has a star as the subtype.\n\nI.E. \"application/*\"",
1463
+ "sourceLocation": {
1464
+ "file": "src/lib/string/mimetype.ts",
1465
+ "line": 30
1466
+ }
1467
+ },
1468
+ {
1469
+ "name": "ContentTypeMimeType",
1470
+ "package": "@dereekb/util",
1471
+ "module": "src/lib/string/mimetype",
1472
+ "kind": "semantic-type",
1473
+ "definition": "string",
1474
+ "baseType": "string",
1475
+ "topics": [
1476
+ "string",
1477
+ "dereekb-util:mime"
1478
+ ],
1479
+ "notes": "A mime type string that may contain additional parameters.\n\nI.E. \"text/plain\", \"application/json; charset=utf-8\"",
1480
+ "sourceLocation": {
1481
+ "file": "src/lib/string/mimetype.ts",
1482
+ "line": 41
1483
+ }
1484
+ },
1485
+ {
1486
+ "name": "PasswordString",
1487
+ "package": "@dereekb/util",
1488
+ "module": "src/lib/string/password",
1489
+ "kind": "semantic-type",
1490
+ "definition": "string",
1491
+ "baseType": "string",
1492
+ "topics": [
1493
+ "string",
1494
+ "dereekb-util:secret"
1495
+ ],
1496
+ "notes": "A password string",
1497
+ "sourceLocation": {
1498
+ "file": "src/lib/string/password.ts",
1499
+ "line": 8
1500
+ }
1501
+ },
1502
+ {
1503
+ "name": "CharacterPrefix",
1504
+ "package": "@dereekb/util",
1505
+ "module": "src/lib/string/prefix",
1506
+ "kind": "semantic-type",
1507
+ "definition": "string",
1508
+ "baseType": "string",
1509
+ "topics": [
1510
+ "string",
1511
+ "dereekb-util:prefix"
1512
+ ],
1513
+ "notes": "A character or string that is added to the start of a string.\n\nExample: '-' in \"-class\"",
1514
+ "sourceLocation": {
1515
+ "file": "src/lib/string/prefix.ts",
1516
+ "line": 12
1517
+ }
1518
+ },
1519
+ {
1520
+ "name": "CharacterSuffix",
1521
+ "package": "@dereekb/util",
1522
+ "module": "src/lib/string/prefix",
1523
+ "kind": "semantic-type",
1524
+ "definition": "string",
1525
+ "baseType": "string",
1526
+ "topics": [
1527
+ "string",
1528
+ "dereekb-util:prefix"
1529
+ ],
1530
+ "notes": "A character or string that is added to the end of a string.\n\nExample: '-' in \"class-\"",
1531
+ "sourceLocation": {
1532
+ "file": "src/lib/string/prefix.ts",
1533
+ "line": 23
1534
+ }
1535
+ },
1536
+ {
1537
+ "name": "CharacterPrefixSuffixCleanString",
1538
+ "package": "@dereekb/util",
1539
+ "module": "src/lib/string/prefix",
1540
+ "kind": "semantic-type",
1541
+ "definition": "string",
1542
+ "baseType": "string",
1543
+ "topics": [
1544
+ "string",
1545
+ "dereekb-util:prefix"
1546
+ ],
1547
+ "notes": "A string that does not have a CharacterPrefix or CharacterSuffix.",
1548
+ "sourceLocation": {
1549
+ "file": "src/lib/string/prefix.ts",
1550
+ "line": 32
1551
+ }
1552
+ },
1553
+ {
1554
+ "name": "SplitStringTreeNodeString",
1555
+ "package": "@dereekb/util",
1556
+ "module": "src/lib/string/tree",
1557
+ "kind": "semantic-type",
1558
+ "definition": "string",
1559
+ "baseType": "string",
1560
+ "topics": [
1561
+ "string",
1562
+ "dereekb-util:tree"
1563
+ ],
1564
+ "notes": "A string value representing a node in a split string tree.",
1565
+ "sourceLocation": {
1566
+ "file": "src/lib/string/tree.ts",
1567
+ "line": 13
1568
+ }
1569
+ },
1570
+ {
1571
+ "name": "WebsiteProtocol",
1572
+ "package": "@dereekb/util",
1573
+ "module": "src/lib/string/url",
1574
+ "kind": "semantic-type",
1575
+ "definition": "string",
1576
+ "baseType": "string",
1577
+ "topics": [
1578
+ "url",
1579
+ "string"
1580
+ ],
1581
+ "notes": "Connection protocol\n\nI.E. http, https, etc.",
1582
+ "sourceLocation": {
1583
+ "file": "src/lib/string/url.ts",
1584
+ "line": 22
1585
+ }
1586
+ },
1587
+ {
1588
+ "name": "WebsiteDomain",
1589
+ "package": "@dereekb/util",
1590
+ "module": "src/lib/string/url",
1591
+ "kind": "semantic-type",
1592
+ "definition": "string",
1593
+ "baseType": "string",
1594
+ "topics": [
1595
+ "url",
1596
+ "string"
1597
+ ],
1598
+ "notes": "A website domain.\n\nExamples:\n- dereekb.com\n- components.dereekb.com",
1599
+ "sourceLocation": {
1600
+ "file": "src/lib/string/url.ts",
1601
+ "line": 59
1602
+ }
1603
+ },
1604
+ {
1605
+ "name": "WebsiteTopLevelDomain",
1606
+ "package": "@dereekb/util",
1607
+ "module": "src/lib/string/url",
1608
+ "kind": "semantic-type",
1609
+ "definition": "string",
1610
+ "baseType": "string",
1611
+ "topics": [
1612
+ "url",
1613
+ "string"
1614
+ ],
1615
+ "notes": "The top-level domain (tld).\n\nExamples:\n- com\n- net",
1616
+ "sourceLocation": {
1617
+ "file": "src/lib/string/url.ts",
1618
+ "line": 94
1619
+ }
1620
+ },
1621
+ {
1622
+ "name": "PortNumber",
1623
+ "package": "@dereekb/util",
1624
+ "module": "src/lib/string/url",
1625
+ "kind": "semantic-type",
1626
+ "definition": "number",
1627
+ "baseType": "number",
1628
+ "topics": [
1629
+ "numeric",
1630
+ "url"
1631
+ ],
1632
+ "notes": "A connection port number.\n\nExample:\n- 443\n- 8080",
1633
+ "sourceLocation": {
1634
+ "file": "src/lib/string/url.ts",
1635
+ "line": 130
1636
+ }
1637
+ },
1638
+ {
1639
+ "name": "WebsiteUrl",
1640
+ "package": "@dereekb/util",
1641
+ "module": "src/lib/string/url",
1642
+ "kind": "semantic-type",
1643
+ "definition": "string",
1644
+ "baseType": "string",
1645
+ "topics": [
1646
+ "url",
1647
+ "string"
1648
+ ],
1649
+ "guards": [
1650
+ "isWebsiteUrl"
1651
+ ],
1652
+ "notes": "A website url. Is at minimum a domain.\n\nExamples:\n- dereekb.com\n- https://components.dereekb.com\n- https://components.dereekb.com/\n- https://components.dereekb.com/doc/home?\n- https://components.dereekb.com/doc/home?test=true&test2=true",
1653
+ "sourceLocation": {
1654
+ "file": "src/lib/string/url.ts",
1655
+ "line": 210
1656
+ }
1657
+ },
1658
+ {
1659
+ "name": "WebsiteUrlWithPrefix",
1660
+ "package": "@dereekb/util",
1661
+ "module": "src/lib/string/url",
1662
+ "kind": "semantic-type",
1663
+ "definition": "string",
1664
+ "baseType": "string",
1665
+ "topics": [
1666
+ "url",
1667
+ "string"
1668
+ ],
1669
+ "guards": [
1670
+ "isWebsiteUrlWithPrefix"
1671
+ ],
1672
+ "notes": "A website url that starts with the proper http/https prefix.",
1673
+ "sourceLocation": {
1674
+ "file": "src/lib/string/url.ts",
1675
+ "line": 317
1676
+ }
1677
+ },
1678
+ {
1679
+ "name": "StandardInternetAccessibleWebsiteUrl",
1680
+ "package": "@dereekb/util",
1681
+ "module": "src/lib/string/url",
1682
+ "kind": "semantic-type",
1683
+ "definition": "string",
1684
+ "baseType": "string",
1685
+ "topics": [
1686
+ "url",
1687
+ "string"
1688
+ ],
1689
+ "guards": [
1690
+ "isStandardInternetAccessibleWebsiteUrl"
1691
+ ],
1692
+ "notes": "A \"standard\" internet accessible website url with a tld (.com/.net/etc) and optionally has the http/https protocol, but no other protocol.\n\nExamples:\n- dereekb.com\n- dereekb.com:8080\n- components.dereekb.com/\n- components.dereekb.com/doc/home\n- http://dereekb.com\n- https://components.dereekb.com/\n- https://components.dereekb.com/doc/home\n\nNon-examples:\n- localhost:8080 // not internet-accessible\n- test://dereekb.com // non-http/https protocol",
1693
+ "sourceLocation": {
1694
+ "file": "src/lib/string/url.ts",
1695
+ "line": 350
1696
+ }
1697
+ },
1698
+ {
1699
+ "name": "WebsiteDomainAndPath",
1700
+ "package": "@dereekb/util",
1701
+ "module": "src/lib/string/url",
1702
+ "kind": "semantic-type",
1703
+ "definition": "string",
1704
+ "baseType": "string",
1705
+ "topics": [
1706
+ "url",
1707
+ "string"
1708
+ ],
1709
+ "notes": "A website's domain and path combined, without the BaseWebsiteUrl\n\nExamples:\n- dereekb.com\n- components.dereekb.com/\n- components.dereekb.com/doc/home",
1710
+ "sourceLocation": {
1711
+ "file": "src/lib/string/url.ts",
1712
+ "line": 375
1713
+ }
1714
+ },
1715
+ {
1716
+ "name": "CityString",
1717
+ "package": "@dereekb/util",
1718
+ "module": "src/lib/value/address",
1719
+ "kind": "semantic-type",
1720
+ "definition": "string",
1721
+ "baseType": "string",
1722
+ "topics": [
1723
+ "geo",
1724
+ "string",
1725
+ "dereekb-util:address"
1726
+ ],
1727
+ "notes": "City name string (e.g. \"San Antonio\").",
1728
+ "sourceLocation": {
1729
+ "file": "src/lib/value/address.ts",
1730
+ "line": 12
1731
+ }
1732
+ },
1733
+ {
1734
+ "name": "StateString",
1735
+ "package": "@dereekb/util",
1736
+ "module": "src/lib/value/address",
1737
+ "kind": "semantic-type",
1738
+ "definition": "string",
1739
+ "baseType": "string",
1740
+ "topics": [
1741
+ "geo",
1742
+ "string",
1743
+ "dereekb-util:address"
1744
+ ],
1745
+ "notes": "Full state name string (e.g. \"Texas\").",
1746
+ "sourceLocation": {
1747
+ "file": "src/lib/value/address.ts",
1748
+ "line": 22
1749
+ }
1750
+ },
1751
+ {
1752
+ "name": "StateCodeString",
1753
+ "package": "@dereekb/util",
1754
+ "module": "src/lib/value/address",
1755
+ "kind": "semantic-type",
1756
+ "definition": "string",
1757
+ "baseType": "string",
1758
+ "topics": [
1759
+ "geo",
1760
+ "string",
1761
+ "dereekb-util:address"
1762
+ ],
1763
+ "notes": "Two-letter US state code (e.g. \"TX\").",
1764
+ "sourceLocation": {
1765
+ "file": "src/lib/value/address.ts",
1766
+ "line": 32
1767
+ }
1768
+ },
1769
+ {
1770
+ "name": "CountryString",
1771
+ "package": "@dereekb/util",
1772
+ "module": "src/lib/value/address",
1773
+ "kind": "semantic-type",
1774
+ "definition": "string",
1775
+ "baseType": "string",
1776
+ "topics": [
1777
+ "geo",
1778
+ "string",
1779
+ "dereekb-util:address"
1780
+ ],
1781
+ "notes": "Full country name string (e.g. \"United States\").",
1782
+ "sourceLocation": {
1783
+ "file": "src/lib/value/address.ts",
1784
+ "line": 42
1785
+ }
1786
+ },
1787
+ {
1788
+ "name": "CountryCodeString",
1789
+ "package": "@dereekb/util",
1790
+ "module": "src/lib/value/address",
1791
+ "kind": "semantic-type",
1792
+ "definition": "string",
1793
+ "baseType": "string",
1794
+ "topics": [
1795
+ "geo",
1796
+ "string",
1797
+ "dereekb-util:address"
1798
+ ],
1799
+ "notes": "Country code string (e.g. \"US\").",
1800
+ "sourceLocation": {
1801
+ "file": "src/lib/value/address.ts",
1802
+ "line": 52
1803
+ }
1804
+ },
1805
+ {
1806
+ "name": "AddressLineString",
1807
+ "package": "@dereekb/util",
1808
+ "module": "src/lib/value/address",
1809
+ "kind": "semantic-type",
1810
+ "definition": "string",
1811
+ "baseType": "string",
1812
+ "topics": [
1813
+ "geo",
1814
+ "string",
1815
+ "dereekb-util:address"
1816
+ ],
1817
+ "notes": "A single line in a street address.",
1818
+ "sourceLocation": {
1819
+ "file": "src/lib/value/address.ts",
1820
+ "line": 62
1821
+ }
1822
+ },
1823
+ {
1824
+ "name": "ZipCodeString",
1825
+ "package": "@dereekb/util",
1826
+ "module": "src/lib/value/address",
1827
+ "kind": "semantic-type",
1828
+ "definition": "string",
1829
+ "baseType": "string",
1830
+ "topics": [
1831
+ "geo",
1832
+ "string",
1833
+ "dereekb-util:address"
1834
+ ],
1835
+ "notes": "Postal/zip code string.",
1836
+ "sourceLocation": {
1837
+ "file": "src/lib/value/address.ts",
1838
+ "line": 72
1839
+ }
1840
+ },
1841
+ {
1842
+ "name": "CronExpression",
1843
+ "package": "@dereekb/util",
1844
+ "module": "src/lib/value/cron",
1845
+ "kind": "semantic-type",
1846
+ "definition": "string",
1847
+ "baseType": "string",
1848
+ "topics": [
1849
+ "string",
1850
+ "dereekb-util:cron"
1851
+ ],
1852
+ "notes": "A cron schedule expression string",
1853
+ "sourceLocation": {
1854
+ "file": "src/lib/value/cron.ts",
1855
+ "line": 11
1856
+ }
1857
+ },
1858
+ {
1859
+ "name": "IndexNumber",
1860
+ "package": "@dereekb/util",
1861
+ "module": "src/lib/value/indexed",
1862
+ "kind": "semantic-type",
1863
+ "definition": "number",
1864
+ "baseType": "number",
1865
+ "topics": [
1866
+ "numeric",
1867
+ "reference"
1868
+ ],
1869
+ "notes": "An integer that denotes which index an item is at.\n\nIs typically non-negative only.",
1870
+ "sourceLocation": {
1871
+ "file": "src/lib/value/indexed.ts",
1872
+ "line": 26
1873
+ }
1874
+ },
1875
+ {
1876
+ "name": "ModifierKey",
1877
+ "package": "@dereekb/util",
1878
+ "module": "src/lib/value/modifier",
1879
+ "kind": "semantic-type",
1880
+ "definition": "string",
1881
+ "baseType": "string",
1882
+ "topics": [
1883
+ "string",
1884
+ "identifier"
1885
+ ],
1886
+ "notes": "String key that uniquely identifies a modifier within a {@link ModifierMap}.",
1887
+ "sourceLocation": {
1888
+ "file": "src/lib/value/modifier.ts",
1889
+ "line": 11
1890
+ }
1891
+ },
1892
+ {
1893
+ "name": "Pixels",
1894
+ "package": "@dereekb/util",
1895
+ "module": "src/lib/value/pixel",
1896
+ "kind": "semantic-type",
1897
+ "definition": "number",
1898
+ "baseType": "number",
1899
+ "topics": [
1900
+ "measurement",
1901
+ "numeric"
1902
+ ],
1903
+ "notes": "Pixel count.",
1904
+ "sourceLocation": {
1905
+ "file": "src/lib/value/pixel.ts",
1906
+ "line": 8
1907
+ }
1908
+ },
1909
+ {
1910
+ "name": "PixelsString",
1911
+ "package": "@dereekb/util",
1912
+ "module": "src/lib/value/pixel",
1913
+ "kind": "semantic-type",
1914
+ "definition": "string",
1915
+ "baseType": "string",
1916
+ "topics": [
1917
+ "measurement",
1918
+ "string"
1919
+ ],
1920
+ "notes": "Pixel count as a string with a \"px\" suffix (e.g. \"100px\").",
1921
+ "sourceLocation": {
1922
+ "file": "src/lib/value/pixel.ts",
1923
+ "line": 17
1924
+ }
1925
+ },
1926
+ {
1927
+ "name": "Latitude",
1928
+ "package": "@dereekb/util",
1929
+ "module": "src/lib/value/point",
1930
+ "kind": "semantic-type",
1931
+ "definition": "number",
1932
+ "baseType": "number",
1933
+ "topics": [
1934
+ "geo",
1935
+ "numeric"
1936
+ ],
1937
+ "notes": "Latitude value in degrees, ranging from -90 to 90.",
1938
+ "sourceLocation": {
1939
+ "file": "src/lib/value/point.ts",
1940
+ "line": 16
1941
+ }
1942
+ },
1943
+ {
1944
+ "name": "Longitude",
1945
+ "package": "@dereekb/util",
1946
+ "module": "src/lib/value/point",
1947
+ "kind": "semantic-type",
1948
+ "definition": "number",
1949
+ "baseType": "number",
1950
+ "topics": [
1951
+ "geo",
1952
+ "numeric"
1953
+ ],
1954
+ "notes": "Longitude value in degrees, ranging from -180 to 180.",
1955
+ "sourceLocation": {
1956
+ "file": "src/lib/value/point.ts",
1957
+ "line": 25
1958
+ }
1959
+ },
1960
+ {
1961
+ "name": "LatLngPoint",
1962
+ "package": "@dereekb/util",
1963
+ "module": "src/lib/value/point",
1964
+ "kind": "semantic-type",
1965
+ "definition": "export interface LatLngPoint {\n lat: Latitude;\n lng: Longitude;\n}",
1966
+ "baseType": "object",
1967
+ "topics": [
1968
+ "geo"
1969
+ ],
1970
+ "guards": [
1971
+ "isLatLngPoint"
1972
+ ],
1973
+ "notes": "A geographic point represented by latitude and longitude.",
1974
+ "sourceLocation": {
1975
+ "file": "src/lib/value/point.ts",
1976
+ "line": 63
1977
+ }
1978
+ },
1979
+ {
1980
+ "name": "ZoomLevel",
1981
+ "package": "@dereekb/util",
1982
+ "module": "src/lib/value/zoom",
1983
+ "kind": "semantic-type",
1984
+ "definition": "number",
1985
+ "baseType": "number",
1986
+ "topics": [
1987
+ "measurement",
1988
+ "numeric"
1989
+ ],
1990
+ "notes": "Camera zoom level.",
1991
+ "sourceLocation": {
1992
+ "file": "src/lib/value/zoom.ts",
1993
+ "line": 8
1994
+ }
1995
+ }
1996
+ ]
1997
+ }