@dereekb/dbx-components-mcp 13.10.6 → 13.10.8

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.
@@ -17,11 +17,7 @@
17
17
  "percent",
18
18
  "numeric"
19
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
- }
20
+ "notes": "Number from 0.0 to 100.0 used for the chance to return true."
25
21
  },
26
22
  {
27
23
  "name": "HashSalt",
@@ -34,11 +30,7 @@
34
30
  "string",
35
31
  "dereekb-util:hash"
36
32
  ],
37
- "notes": "Represents a salt value used in hashing.",
38
- "sourceLocation": {
39
- "file": "src/lib/hash.ts",
40
- "line": 10
41
- }
33
+ "notes": "Represents a salt value used in hashing."
42
34
  },
43
35
  {
44
36
  "name": "SortComparisonNumber",
@@ -50,11 +42,7 @@
50
42
  "topics": [
51
43
  "numeric"
52
44
  ],
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
- }
45
+ "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"
58
46
  },
59
47
  {
60
48
  "name": "BooleanStringKey",
@@ -67,11 +55,7 @@
67
55
  "identifier",
68
56
  "string"
69
57
  ],
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
- }
58
+ "notes": "A string type used as a key in boolean arrays."
75
59
  },
76
60
  {
77
61
  "name": "RangeInputEndValue",
@@ -83,11 +67,7 @@
83
67
  "topics": [
84
68
  "numeric"
85
69
  ],
86
- "notes": "Exclusive end value used by range().",
87
- "sourceLocation": {
88
- "file": "src/lib/array/array.number.ts",
89
- "line": 99
90
- }
70
+ "notes": "Exclusive end value used by range()."
91
71
  },
92
72
  {
93
73
  "name": "AuthClaimKey",
@@ -101,11 +81,7 @@
101
81
  "string",
102
82
  "dereekb-util:auth"
103
83
  ],
104
- "notes": "Key in the claims.",
105
- "sourceLocation": {
106
- "file": "src/lib/auth/auth.role.claims.ts",
107
- "line": 17
108
- }
84
+ "notes": "Key in the claims."
109
85
  },
110
86
  {
111
87
  "name": "AuthRole",
@@ -119,11 +95,7 @@
119
95
  "string",
120
96
  "dereekb-util:auth"
121
97
  ],
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
- }
98
+ "notes": "An application role.\n\nIs used in the client to decide which content a user can view.\n\nRoles should always be lowercase."
127
99
  },
128
100
  {
129
101
  "name": "EmailAddressDomain",
@@ -137,11 +109,7 @@
137
109
  "contact",
138
110
  "string"
139
111
  ],
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
- }
112
+ "notes": "Domain name portion of an email address (e.g., \"example.com\")."
145
113
  },
146
114
  {
147
115
  "name": "EmailAddress",
@@ -155,11 +123,7 @@
155
123
  "contact",
156
124
  "string"
157
125
  ],
158
- "notes": "Type representing an email address as a string.",
159
- "sourceLocation": {
160
- "file": "src/lib/contact/email.ts",
161
- "line": 11
162
- }
126
+ "notes": "Type representing an email address as a string."
163
127
  },
164
128
  {
165
129
  "name": "EmailParticipantString",
@@ -173,11 +137,7 @@
173
137
  "contact",
174
138
  "string"
175
139
  ],
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
- }
140
+ "notes": "Email participant string. Starts with the email, followed by the name if available."
181
141
  },
182
142
  {
183
143
  "name": "PhoneNumber",
@@ -191,11 +151,7 @@
191
151
  "contact",
192
152
  "string"
193
153
  ],
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
- }
154
+ "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"
199
155
  },
200
156
  {
201
157
  "name": "PhoneExtensionNumber",
@@ -209,11 +165,7 @@
209
165
  "contact",
210
166
  "string"
211
167
  ],
212
- "notes": "1-6 digit extension number",
213
- "sourceLocation": {
214
- "file": "src/lib/contact/phone.ts",
215
- "line": 31
216
- }
168
+ "notes": "1-6 digit extension number"
217
169
  },
218
170
  {
219
171
  "name": "ReadableTimeString",
@@ -226,11 +178,7 @@
226
178
  "time",
227
179
  "string"
228
180
  ],
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
- }
181
+ "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"
234
182
  },
235
183
  {
236
184
  "name": "RFC3339DateString",
@@ -243,11 +191,7 @@
243
191
  "date",
244
192
  "string"
245
193
  ],
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
- }
194
+ "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."
251
195
  },
252
196
  {
253
197
  "name": "ISO8601DateString",
@@ -263,11 +207,7 @@
263
207
  "guards": [
264
208
  "isISO8601DateString"
265
209
  ],
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
- }
210
+ "notes": "A valid ISO8601 formatted date string.\n\nI.E. \"2020-04-30T00:00:00.000Z\""
271
211
  },
272
212
  {
273
213
  "name": "UTCDateString",
@@ -283,11 +223,7 @@
283
223
  "guards": [
284
224
  "isUTCDateString"
285
225
  ],
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
- }
226
+ "notes": "A UTC date string.\n\nI.E. \"Sat, 03 Feb 2001 04:05:06 GMT\""
291
227
  },
292
228
  {
293
229
  "name": "ISO8601DateStringUTCFull",
@@ -300,11 +236,7 @@
300
236
  "date",
301
237
  "string"
302
238
  ],
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
- }
239
+ "notes": "A full ISO8601 date string that is in UTC.\n\nI.E. \"2020-04-30T00:00:00.000Z\""
308
240
  },
309
241
  {
310
242
  "name": "TimezoneString",
@@ -317,11 +249,7 @@
317
249
  "timezone",
318
250
  "string"
319
251
  ],
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
- }
252
+ "notes": "A valid timezone string.\n\nI.E. \"UTC\", \"America/Denver\", etc."
325
253
  },
326
254
  {
327
255
  "name": "TimezoneAbbreviation",
@@ -334,11 +262,7 @@
334
262
  "timezone",
335
263
  "string"
336
264
  ],
337
- "notes": "A timezone abbreviation (UTC, EST, etc).",
338
- "sourceLocation": {
339
- "file": "src/lib/date/date.ts",
340
- "line": 114
341
- }
265
+ "notes": "A timezone abbreviation (UTC, EST, etc)."
342
266
  },
343
267
  {
344
268
  "name": "ISO8601DayString",
@@ -354,11 +278,7 @@
354
278
  "guards": [
355
279
  "isISO8601DayString"
356
280
  ],
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
- }
281
+ "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"
362
282
  },
363
283
  {
364
284
  "name": "MonthDaySlashDate",
@@ -374,11 +294,7 @@
374
294
  "guards": [
375
295
  "isMonthDaySlashDate"
376
296
  ],
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
- }
297
+ "notes": "Date that is represented by slashes. Is considered in the Month/Day/Year format."
382
298
  },
383
299
  {
384
300
  "name": "UnixDateTimeMillisecondsNumber",
@@ -391,11 +307,7 @@
391
307
  "time",
392
308
  "numeric"
393
309
  ],
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
- }
310
+ "notes": "Time in milliseconds since the epoch.\n\nReturned by Date.getTime()."
399
311
  },
400
312
  {
401
313
  "name": "Milliseconds",
@@ -409,11 +321,7 @@
409
321
  "duration",
410
322
  "numeric"
411
323
  ],
412
- "notes": "Number of milliseconds.",
413
- "sourceLocation": {
414
- "file": "src/lib/date/date.ts",
415
- "line": 358
416
- }
324
+ "notes": "Number of milliseconds."
417
325
  },
418
326
  {
419
327
  "name": "Seconds",
@@ -427,11 +335,7 @@
427
335
  "duration",
428
336
  "numeric"
429
337
  ],
430
- "notes": "Number of seconds.",
431
- "sourceLocation": {
432
- "file": "src/lib/date/date.ts",
433
- "line": 388
434
- }
338
+ "notes": "Number of seconds."
435
339
  },
436
340
  {
437
341
  "name": "Minutes",
@@ -445,11 +349,7 @@
445
349
  "duration",
446
350
  "numeric"
447
351
  ],
448
- "notes": "Number of minutes.",
449
- "sourceLocation": {
450
- "file": "src/lib/date/date.ts",
451
- "line": 398
452
- }
352
+ "notes": "Number of minutes."
453
353
  },
454
354
  {
455
355
  "name": "Hours",
@@ -463,11 +363,7 @@
463
363
  "duration",
464
364
  "numeric"
465
365
  ],
466
- "notes": "Number of hours.",
467
- "sourceLocation": {
468
- "file": "src/lib/date/date.ts",
469
- "line": 408
470
- }
366
+ "notes": "Number of hours."
471
367
  },
472
368
  {
473
369
  "name": "Days",
@@ -481,11 +377,7 @@
481
377
  "duration",
482
378
  "numeric"
483
379
  ],
484
- "notes": "Number of days.",
485
- "sourceLocation": {
486
- "file": "src/lib/date/date.ts",
487
- "line": 418
488
- }
380
+ "notes": "Number of days."
489
381
  },
490
382
  {
491
383
  "name": "DayOfMonth",
@@ -498,11 +390,7 @@
498
390
  "date",
499
391
  "numeric"
500
392
  ],
501
- "notes": "Day of the month, 1-31",
502
- "sourceLocation": {
503
- "file": "src/lib/date/date.ts",
504
- "line": 487
505
- }
393
+ "notes": "Day of the month, 1-31"
506
394
  },
507
395
  {
508
396
  "name": "MonthOfYear",
@@ -515,11 +403,7 @@
515
403
  "date",
516
404
  "numeric"
517
405
  ],
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
- }
406
+ "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."
523
407
  },
524
408
  {
525
409
  "name": "DateMonth",
@@ -532,11 +416,7 @@
532
416
  "date",
533
417
  "numeric"
534
418
  ],
535
- "notes": "Javascript Date month number. 0-11.",
536
- "sourceLocation": {
537
- "file": "src/lib/date/date.ts",
538
- "line": 507
539
- }
419
+ "notes": "Javascript Date month number. 0-11."
540
420
  },
541
421
  {
542
422
  "name": "YearNumber",
@@ -549,11 +429,7 @@
549
429
  "date",
550
430
  "numeric"
551
431
  ],
552
- "notes": "Year number. I.E. 2022",
553
- "sourceLocation": {
554
- "file": "src/lib/date/date.ts",
555
- "line": 560
556
- }
432
+ "notes": "Year number. I.E. 2022"
557
433
  },
558
434
  {
559
435
  "name": "UnixDateTimeSecondsNumber",
@@ -566,11 +442,7 @@
566
442
  "time",
567
443
  "numeric"
568
444
  ],
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
- }
445
+ "notes": "This value is in seconds since the Epoch.\n\nUse UnixDateTimeMillisecondsNumber instead if you need milliseconds."
574
446
  },
575
447
  {
576
448
  "name": "FractionalHour",
@@ -583,11 +455,7 @@
583
455
  "date",
584
456
  "numeric"
585
457
  ],
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
- }
458
+ "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"
591
459
  },
592
460
  {
593
461
  "name": "MinuteOfDay",
@@ -603,11 +471,7 @@
603
471
  "guards": [
604
472
  "isMinuteOfDay"
605
473
  ],
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
- }
474
+ "notes": "The minute of the day.\n\nNumber from 0-1439."
611
475
  },
612
476
  {
613
477
  "name": "EncryptedString",
@@ -620,11 +484,7 @@
620
484
  "string",
621
485
  "dereekb-util:encryption"
622
486
  ],
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
- }
487
+ "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}."
628
488
  },
629
489
  {
630
490
  "name": "StringErrorCode",
@@ -637,11 +497,7 @@
637
497
  "identifier",
638
498
  "string"
639
499
  ],
640
- "notes": "A unique identifier for a specific error.",
641
- "sourceLocation": {
642
- "file": "src/lib/error/error.ts",
643
- "line": 17
644
- }
500
+ "notes": "A unique identifier for a specific error."
645
501
  },
646
502
  {
647
503
  "name": "FileSize",
@@ -654,11 +510,7 @@
654
510
  "measurement",
655
511
  "numeric"
656
512
  ],
657
- "notes": "File size in bytes.",
658
- "sourceLocation": {
659
- "file": "src/lib/file/file.ts",
660
- "line": 8
661
- }
513
+ "notes": "File size in bytes."
662
514
  },
663
515
  {
664
516
  "name": "XMLSVG",
@@ -671,11 +523,7 @@
671
523
  "string",
672
524
  "dereekb-util:xml"
673
525
  ],
674
- "notes": "String value containing an XML SVG string.",
675
- "sourceLocation": {
676
- "file": "src/lib/file/xml.ts",
677
- "line": 8
678
- }
526
+ "notes": "String value containing an XML SVG string."
679
527
  },
680
528
  {
681
529
  "name": "ModelKey",
@@ -691,11 +539,7 @@
691
539
  "guards": [
692
540
  "isModelKey"
693
541
  ],
694
- "notes": "A string model key",
695
- "sourceLocation": {
696
- "file": "src/lib/model/model.ts",
697
- "line": 14
698
- }
542
+ "notes": "A string model key"
699
543
  },
700
544
  {
701
545
  "name": "ModelId",
@@ -708,11 +552,7 @@
708
552
  "identifier",
709
553
  "string"
710
554
  ],
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
- }
555
+ "notes": "A string model identifier (typically the document/record ID segment, not the full path)."
716
556
  },
717
557
  {
718
558
  "name": "ModelTypeString",
@@ -725,11 +565,7 @@
725
565
  "identifier",
726
566
  "string"
727
567
  ],
728
- "notes": "Arbitrary model type.",
729
- "sourceLocation": {
730
- "file": "src/lib/model/model.ts",
731
- "line": 32
732
- }
568
+ "notes": "Arbitrary model type."
733
569
  },
734
570
  {
735
571
  "name": "TypedModelKey",
@@ -742,11 +578,7 @@
742
578
  "identifier",
743
579
  "string"
744
580
  ],
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
- }
581
+ "notes": "String model key from which the model's type can be inferred from."
750
582
  },
751
583
  {
752
584
  "name": "ModelKeyTypePairString",
@@ -759,11 +591,7 @@
759
591
  "identifier",
760
592
  "string"
761
593
  ],
762
- "notes": "An encoded ModelKeyTypePair.",
763
- "sourceLocation": {
764
- "file": "src/lib/model/model.ts",
765
- "line": 86
766
- }
594
+ "notes": "An encoded ModelKeyTypePair."
767
595
  },
768
596
  {
769
597
  "name": "BitwiseEncodedSetIndex",
@@ -776,11 +604,7 @@
776
604
  "numeric",
777
605
  "dereekb-util:encoding"
778
606
  ],
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
- }
607
+ "notes": "Enum or number value from 0 to 31 that denotes a specific item via index of the bit to measure."
784
608
  },
785
609
  {
786
610
  "name": "BitwiseEncodedSet",
@@ -793,11 +617,7 @@
793
617
  "numeric",
794
618
  "dereekb-util:encoding"
795
619
  ],
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
- }
620
+ "notes": "Set of values that are encoded into a single number.\n\nThe number can include up to 32 unique boolean values."
801
621
  },
802
622
  {
803
623
  "name": "WholeDollarAmount",
@@ -810,11 +630,7 @@
810
630
  "currency",
811
631
  "numeric"
812
632
  ],
813
- "notes": "Whole dollar amounts, before the ','.",
814
- "sourceLocation": {
815
- "file": "src/lib/number/dollar.ts",
816
- "line": 11
817
- }
633
+ "notes": "Whole dollar amounts, before the ','."
818
634
  },
819
635
  {
820
636
  "name": "DollarAmount",
@@ -827,11 +643,7 @@
827
643
  "currency",
828
644
  "numeric"
829
645
  ],
830
- "notes": "Dollar amount number.",
831
- "sourceLocation": {
832
- "file": "src/lib/number/dollar.ts",
833
- "line": 20
834
- }
646
+ "notes": "Dollar amount number."
835
647
  },
836
648
  {
837
649
  "name": "DollarAmountPerHour",
@@ -844,11 +656,7 @@
844
656
  "currency",
845
657
  "numeric"
846
658
  ],
847
- "notes": "Dollars amount number per hour.",
848
- "sourceLocation": {
849
- "file": "src/lib/number/dollar.ts",
850
- "line": 29
851
- }
659
+ "notes": "Dollars amount number per hour."
852
660
  },
853
661
  {
854
662
  "name": "DollarAmountPerDay",
@@ -861,11 +669,7 @@
861
669
  "currency",
862
670
  "numeric"
863
671
  ],
864
- "notes": "Dollars amount number per day.",
865
- "sourceLocation": {
866
- "file": "src/lib/number/dollar.ts",
867
- "line": 38
868
- }
672
+ "notes": "Dollars amount number per day."
869
673
  },
870
674
  {
871
675
  "name": "CentsAmount",
@@ -878,11 +682,7 @@
878
682
  "currency",
879
683
  "numeric"
880
684
  ],
881
- "notes": "Amount in whole cents.",
882
- "sourceLocation": {
883
- "file": "src/lib/number/dollar.ts",
884
- "line": 47
885
- }
685
+ "notes": "Amount in whole cents."
886
686
  },
887
687
  {
888
688
  "name": "DollarAmountUnit",
@@ -895,11 +695,7 @@
895
695
  "currency",
896
696
  "string"
897
697
  ],
898
- "notes": "Unit to affix to a dollar amount string.",
899
- "sourceLocation": {
900
- "file": "src/lib/number/dollar.ts",
901
- "line": 61
902
- }
698
+ "notes": "Unit to affix to a dollar amount string."
903
699
  },
904
700
  {
905
701
  "name": "DollarAmountString",
@@ -915,11 +711,7 @@
915
711
  "guards": [
916
712
  "isDollarAmountString"
917
713
  ],
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
- }
714
+ "notes": "String representing a dollar amount.\n\nIs formatted as a number with two decimal places. No unit is affixed."
923
715
  },
924
716
  {
925
717
  "name": "Radix36EncodedNumber",
@@ -937,11 +729,7 @@
937
729
  "code": "const encoded: Radix36EncodedNumber = 'z'; // represents 35\nconst largeEncoded: Radix36EncodedNumber = '2s'; // represents 100"
938
730
  }
939
731
  ],
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
- }
732
+ "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."
945
733
  },
946
734
  {
947
735
  "name": "HexString",
@@ -954,11 +742,7 @@
954
742
  "string",
955
743
  "dereekb-util:encoding"
956
744
  ],
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
- }
745
+ "notes": "A string containing only hexadecimal characters (0-9, a-f or A-F)."
962
746
  },
963
747
  {
964
748
  "name": "Count",
@@ -975,11 +759,7 @@
975
759
  "code": "const totalUsers: Count = 42;"
976
760
  }
977
761
  ],
978
- "notes": "A non-negative integer representing a count of items.",
979
- "sourceLocation": {
980
- "file": "src/lib/number/number.ts",
981
- "line": 16
982
- }
762
+ "notes": "A non-negative integer representing a count of items."
983
763
  },
984
764
  {
985
765
  "name": "NumberString",
@@ -992,11 +772,7 @@
992
772
  "numeric",
993
773
  "string"
994
774
  ],
995
- "notes": "A string represented within a number.",
996
- "sourceLocation": {
997
- "file": "src/lib/number/number.ts",
998
- "line": 25
999
- }
775
+ "notes": "A string represented within a number."
1000
776
  },
1001
777
  {
1002
778
  "name": "PercentNumber",
@@ -1009,11 +785,7 @@
1009
785
  "percent",
1010
786
  "numeric"
1011
787
  ],
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
- }
788
+ "notes": "Number that represents a percent.\n\n e.g. PercentNumber of 5 = 0.05 = 5%"
1017
789
  },
1018
790
  {
1019
791
  "name": "PercentDecimal",
@@ -1026,11 +798,7 @@
1026
798
  "percent",
1027
799
  "numeric"
1028
800
  ],
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
- }
801
+ "notes": "A percent decimal value.\n\ne.g. PercentDecimal of 0.05 = 5%"
1034
802
  },
1035
803
  {
1036
804
  "name": "PayRate",
@@ -1043,11 +811,7 @@
1043
811
  "currency",
1044
812
  "numeric"
1045
813
  ],
1046
- "notes": "Rate per hour the worker should be paid.",
1047
- "sourceLocation": {
1048
- "file": "src/lib/number/pay.ts",
1049
- "line": 8
1050
- }
814
+ "notes": "Rate per hour the worker should be paid."
1051
815
  },
1052
816
  {
1053
817
  "name": "PayAmount",
@@ -1060,11 +824,7 @@
1060
824
  "currency",
1061
825
  "numeric"
1062
826
  ],
1063
- "notes": "The total pay amount that should be paid.",
1064
- "sourceLocation": {
1065
- "file": "src/lib/number/pay.ts",
1066
- "line": 17
1067
- }
827
+ "notes": "The total pay amount that should be paid."
1068
828
  },
1069
829
  {
1070
830
  "name": "NumberPrecision",
@@ -1077,11 +837,7 @@
1077
837
  "numeric",
1078
838
  "measurement"
1079
839
  ],
1080
- "notes": "The number of decimal places ot use.",
1081
- "sourceLocation": {
1082
- "file": "src/lib/number/round.ts",
1083
- "line": 49
1084
- }
840
+ "notes": "The number of decimal places ot use."
1085
841
  },
1086
842
  {
1087
843
  "name": "StepNumber",
@@ -1093,11 +849,7 @@
1093
849
  "topics": [
1094
850
  "numeric"
1095
851
  ],
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
- }
852
+ "notes": "Number used to increase or decrease by the \"step\" value. When used in rounding the steps are aligned at a StepOrigin."
1101
853
  },
1102
854
  {
1103
855
  "name": "StepOrigin",
@@ -1109,11 +861,7 @@
1109
861
  "topics": [
1110
862
  "numeric"
1111
863
  ],
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
- }
864
+ "notes": "Origin value for StepNumbers that is used as an offset for input. Is usually 0."
1117
865
  },
1118
866
  {
1119
867
  "name": "ObjectKey",
@@ -1126,11 +874,7 @@
1126
874
  "identifier",
1127
875
  "string"
1128
876
  ],
1129
- "notes": "String key of an object.",
1130
- "sourceLocation": {
1131
- "file": "src/lib/object/object.ts",
1132
- "line": 23
1133
- }
877
+ "notes": "String key of an object."
1134
878
  },
1135
879
  {
1136
880
  "name": "PageNumber",
@@ -1144,11 +888,7 @@
1144
888
  "reference",
1145
889
  "dereekb-util:pagination"
1146
890
  ],
1147
- "notes": "Numeric page identifier.",
1148
- "sourceLocation": {
1149
- "file": "src/lib/page/page.ts",
1150
- "line": 26
1151
- }
891
+ "notes": "Numeric page identifier."
1152
892
  },
1153
893
  {
1154
894
  "name": "SlashPathTypedFileExtension",
@@ -1161,11 +901,7 @@
1161
901
  "string",
1162
902
  "dereekb-util:path"
1163
903
  ],
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
- }
904
+ "notes": "The file extension of a SlashPathTypedFile.\n\ne.g. 'png' in 'image.png'"
1169
905
  },
1170
906
  {
1171
907
  "name": "SlashPathUntypedFile",
@@ -1178,11 +914,7 @@
1178
914
  "string",
1179
915
  "dereekb-util:path"
1180
916
  ],
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
- }
917
+ "notes": "A SlashPath file name without a file type identifier (e.g. 'image', and not 'image.png')"
1186
918
  },
1187
919
  {
1188
920
  "name": "PerformTasksInParallelTaskUniqueKey",
@@ -1196,11 +928,7 @@
1196
928
  "string",
1197
929
  "dereekb-util:concurrency"
1198
930
  ],
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
- }
931
+ "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."
1204
932
  },
1205
933
  {
1206
934
  "name": "RelationString",
@@ -1214,11 +942,7 @@
1214
942
  "string",
1215
943
  "dereekb-util:relation"
1216
944
  ],
1217
- "notes": "A string-based relation identifier.",
1218
- "sourceLocation": {
1219
- "file": "src/lib/relation/relation.ts",
1220
- "line": 54
1221
- }
945
+ "notes": "A string-based relation identifier."
1222
946
  },
1223
947
  {
1224
948
  "name": "RelationModelType",
@@ -1232,11 +956,7 @@
1232
956
  "string",
1233
957
  "dereekb-util:relation"
1234
958
  ],
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
- }
959
+ "notes": "A string identifying the type/category of a relation model."
1240
960
  },
1241
961
  {
1242
962
  "name": "StoredDataString",
@@ -1249,11 +969,7 @@
1249
969
  "string",
1250
970
  "reference"
1251
971
  ],
1252
- "notes": "String representation of data that is stored.",
1253
- "sourceLocation": {
1254
- "file": "src/lib/storage/storage.ts",
1255
- "line": 10
1256
- }
972
+ "notes": "String representation of data that is stored."
1257
973
  },
1258
974
  {
1259
975
  "name": "StoredDataStorageKey",
@@ -1267,11 +983,7 @@
1267
983
  "string",
1268
984
  "reference"
1269
985
  ],
1270
- "notes": "Key used for accessing stored data.",
1271
- "sourceLocation": {
1272
- "file": "src/lib/storage/storage.ts",
1273
- "line": 19
1274
- }
986
+ "notes": "Key used for accessing stored data."
1275
987
  },
1276
988
  {
1277
989
  "name": "NumberStringDencoderNumber",
@@ -1284,11 +996,7 @@
1284
996
  "numeric",
1285
997
  "dereekb-util:encoding"
1286
998
  ],
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
- }
999
+ "notes": "An encodable number. This is typically a positive integer value."
1292
1000
  },
1293
1001
  {
1294
1002
  "name": "NumberStringDencoderString",
@@ -1301,11 +1009,7 @@
1301
1009
  "string",
1302
1010
  "dereekb-util:encoding"
1303
1011
  ],
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
- }
1012
+ "notes": "A number-encoded string. Little-Endian. Should Decode to the same value each time."
1309
1013
  },
1310
1014
  {
1311
1015
  "name": "NumberStringDencoderDigits",
@@ -1318,11 +1022,7 @@
1318
1022
  "string",
1319
1023
  "dereekb-util:encoding"
1320
1024
  ],
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
- }
1025
+ "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"
1326
1026
  },
1327
1027
  {
1328
1028
  "name": "CssClass",
@@ -1335,11 +1035,7 @@
1335
1035
  "string",
1336
1036
  "dereekb-util:css"
1337
1037
  ],
1338
- "notes": "Represents a single CSS Class",
1339
- "sourceLocation": {
1340
- "file": "src/lib/string/html.ts",
1341
- "line": 21
1342
- }
1038
+ "notes": "Represents a single CSS Class"
1343
1039
  },
1344
1040
  {
1345
1041
  "name": "CssTokenName",
@@ -1357,11 +1053,7 @@
1357
1053
  "code": "const name: CssTokenName = 'dbx-primary-color';"
1358
1054
  }
1359
1055
  ],
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
- }
1056
+ "notes": "The name portion of a CSS token, without the leading `--` prefix."
1365
1057
  },
1366
1058
  {
1367
1059
  "name": "CssStyle",
@@ -1374,11 +1066,7 @@
1374
1066
  "string",
1375
1067
  "dereekb-util:css"
1376
1068
  ],
1377
- "notes": "Represents a single CSS Style",
1378
- "sourceLocation": {
1379
- "file": "src/lib/string/html.ts",
1380
- "line": 95
1381
- }
1069
+ "notes": "Represents a single CSS Style"
1382
1070
  },
1383
1071
  {
1384
1072
  "name": "SpaceSeparatedCssClasses",
@@ -1391,11 +1079,7 @@
1391
1079
  "string",
1392
1080
  "dereekb-util:css"
1393
1081
  ],
1394
- "notes": "Represents one or more CssClasses that are space separated.",
1395
- "sourceLocation": {
1396
- "file": "src/lib/string/html.ts",
1397
- "line": 104
1398
- }
1082
+ "notes": "Represents one or more CssClasses that are space separated."
1399
1083
  },
1400
1084
  {
1401
1085
  "name": "SpaceSeparatedCssStyles",
@@ -1408,11 +1092,7 @@
1408
1092
  "string",
1409
1093
  "dereekb-util:css"
1410
1094
  ],
1411
- "notes": "Represents one or more CssStyles that are space separated.",
1412
- "sourceLocation": {
1413
- "file": "src/lib/string/html.ts",
1414
- "line": 118
1415
- }
1095
+ "notes": "Represents one or more CssStyles that are space separated."
1416
1096
  },
1417
1097
  {
1418
1098
  "name": "JSONEncodedString",
@@ -1425,11 +1105,7 @@
1425
1105
  "string",
1426
1106
  "dereekb-util:encoding"
1427
1107
  ],
1428
- "notes": "A json encoded string.",
1429
- "sourceLocation": {
1430
- "file": "src/lib/string/json.ts",
1431
- "line": 8
1432
- }
1108
+ "notes": "A json encoded string."
1433
1109
  },
1434
1110
  {
1435
1111
  "name": "MimeTypeWithoutParameters",
@@ -1442,11 +1118,7 @@
1442
1118
  "string",
1443
1119
  "dereekb-util:mime"
1444
1120
  ],
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
- }
1121
+ "notes": "A simple mime type string with just the type/subtype and no parameters.\n\nI.E. \"application/json\""
1450
1122
  },
1451
1123
  {
1452
1124
  "name": "MimeTypeWithSubtypeWildcardWithoutParameters",
@@ -1459,11 +1131,7 @@
1459
1131
  "string",
1460
1132
  "dereekb-util:mime"
1461
1133
  ],
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
- }
1134
+ "notes": "A mime type with a wildcard subtype. Has a star as the subtype.\n\nI.E. \"application/*\""
1467
1135
  },
1468
1136
  {
1469
1137
  "name": "ContentTypeMimeType",
@@ -1476,11 +1144,7 @@
1476
1144
  "string",
1477
1145
  "dereekb-util:mime"
1478
1146
  ],
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
- }
1147
+ "notes": "A mime type string that may contain additional parameters.\n\nI.E. \"text/plain\", \"application/json; charset=utf-8\""
1484
1148
  },
1485
1149
  {
1486
1150
  "name": "PasswordString",
@@ -1493,11 +1157,7 @@
1493
1157
  "string",
1494
1158
  "dereekb-util:secret"
1495
1159
  ],
1496
- "notes": "A password string",
1497
- "sourceLocation": {
1498
- "file": "src/lib/string/password.ts",
1499
- "line": 8
1500
- }
1160
+ "notes": "A password string"
1501
1161
  },
1502
1162
  {
1503
1163
  "name": "CharacterPrefix",
@@ -1510,11 +1170,7 @@
1510
1170
  "string",
1511
1171
  "dereekb-util:prefix"
1512
1172
  ],
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
- }
1173
+ "notes": "A character or string that is added to the start of a string.\n\nExample: '-' in \"-class\""
1518
1174
  },
1519
1175
  {
1520
1176
  "name": "CharacterSuffix",
@@ -1527,11 +1183,7 @@
1527
1183
  "string",
1528
1184
  "dereekb-util:prefix"
1529
1185
  ],
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
- }
1186
+ "notes": "A character or string that is added to the end of a string.\n\nExample: '-' in \"class-\""
1535
1187
  },
1536
1188
  {
1537
1189
  "name": "CharacterPrefixSuffixCleanString",
@@ -1544,11 +1196,7 @@
1544
1196
  "string",
1545
1197
  "dereekb-util:prefix"
1546
1198
  ],
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
- }
1199
+ "notes": "A string that does not have a CharacterPrefix or CharacterSuffix."
1552
1200
  },
1553
1201
  {
1554
1202
  "name": "SplitStringTreeNodeString",
@@ -1561,11 +1209,7 @@
1561
1209
  "string",
1562
1210
  "dereekb-util:tree"
1563
1211
  ],
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
- }
1212
+ "notes": "A string value representing a node in a split string tree."
1569
1213
  },
1570
1214
  {
1571
1215
  "name": "WebsiteProtocol",
@@ -1578,11 +1222,7 @@
1578
1222
  "url",
1579
1223
  "string"
1580
1224
  ],
1581
- "notes": "Connection protocol\n\nI.E. http, https, etc.",
1582
- "sourceLocation": {
1583
- "file": "src/lib/string/url.ts",
1584
- "line": 22
1585
- }
1225
+ "notes": "Connection protocol\n\nI.E. http, https, etc."
1586
1226
  },
1587
1227
  {
1588
1228
  "name": "WebsiteDomain",
@@ -1595,11 +1235,7 @@
1595
1235
  "url",
1596
1236
  "string"
1597
1237
  ],
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
- }
1238
+ "notes": "A website domain.\n\nExamples:\n- dereekb.com\n- components.dereekb.com"
1603
1239
  },
1604
1240
  {
1605
1241
  "name": "WebsiteTopLevelDomain",
@@ -1612,11 +1248,7 @@
1612
1248
  "url",
1613
1249
  "string"
1614
1250
  ],
1615
- "notes": "The top-level domain (tld).\n\nExamples:\n- com\n- net",
1616
- "sourceLocation": {
1617
- "file": "src/lib/string/url.ts",
1618
- "line": 97
1619
- }
1251
+ "notes": "The top-level domain (tld).\n\nExamples:\n- com\n- net"
1620
1252
  },
1621
1253
  {
1622
1254
  "name": "PortNumber",
@@ -1629,11 +1261,7 @@
1629
1261
  "numeric",
1630
1262
  "url"
1631
1263
  ],
1632
- "notes": "A connection port number.\n\nExample:\n- 443\n- 8080",
1633
- "sourceLocation": {
1634
- "file": "src/lib/string/url.ts",
1635
- "line": 133
1636
- }
1264
+ "notes": "A connection port number.\n\nExample:\n- 443\n- 8080"
1637
1265
  },
1638
1266
  {
1639
1267
  "name": "WebsiteUrl",
@@ -1649,11 +1277,7 @@
1649
1277
  "guards": [
1650
1278
  "isWebsiteUrl"
1651
1279
  ],
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": 213
1656
- }
1280
+ "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"
1657
1281
  },
1658
1282
  {
1659
1283
  "name": "WebsiteUrlWithPrefix",
@@ -1669,11 +1293,7 @@
1669
1293
  "guards": [
1670
1294
  "isWebsiteUrlWithPrefix"
1671
1295
  ],
1672
- "notes": "A website url that starts with the proper http/https prefix.",
1673
- "sourceLocation": {
1674
- "file": "src/lib/string/url.ts",
1675
- "line": 320
1676
- }
1296
+ "notes": "A website url that starts with the proper http/https prefix."
1677
1297
  },
1678
1298
  {
1679
1299
  "name": "StandardInternetAccessibleWebsiteUrl",
@@ -1689,11 +1309,7 @@
1689
1309
  "guards": [
1690
1310
  "isStandardInternetAccessibleWebsiteUrl"
1691
1311
  ],
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": 353
1696
- }
1312
+ "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"
1697
1313
  },
1698
1314
  {
1699
1315
  "name": "WebsiteDomainAndPath",
@@ -1706,11 +1322,7 @@
1706
1322
  "url",
1707
1323
  "string"
1708
1324
  ],
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": 378
1713
- }
1325
+ "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"
1714
1326
  },
1715
1327
  {
1716
1328
  "name": "CityString",
@@ -1724,11 +1336,7 @@
1724
1336
  "string",
1725
1337
  "dereekb-util:address"
1726
1338
  ],
1727
- "notes": "City name string (e.g. \"San Antonio\").",
1728
- "sourceLocation": {
1729
- "file": "src/lib/value/address.ts",
1730
- "line": 12
1731
- }
1339
+ "notes": "City name string (e.g. \"San Antonio\")."
1732
1340
  },
1733
1341
  {
1734
1342
  "name": "StateString",
@@ -1742,11 +1350,7 @@
1742
1350
  "string",
1743
1351
  "dereekb-util:address"
1744
1352
  ],
1745
- "notes": "Full state name string (e.g. \"Texas\").",
1746
- "sourceLocation": {
1747
- "file": "src/lib/value/address.ts",
1748
- "line": 22
1749
- }
1353
+ "notes": "Full state name string (e.g. \"Texas\")."
1750
1354
  },
1751
1355
  {
1752
1356
  "name": "StateCodeString",
@@ -1760,11 +1364,7 @@
1760
1364
  "string",
1761
1365
  "dereekb-util:address"
1762
1366
  ],
1763
- "notes": "Two-letter US state code (e.g. \"TX\").",
1764
- "sourceLocation": {
1765
- "file": "src/lib/value/address.ts",
1766
- "line": 32
1767
- }
1367
+ "notes": "Two-letter US state code (e.g. \"TX\")."
1768
1368
  },
1769
1369
  {
1770
1370
  "name": "CountryString",
@@ -1778,11 +1378,7 @@
1778
1378
  "string",
1779
1379
  "dereekb-util:address"
1780
1380
  ],
1781
- "notes": "Full country name string (e.g. \"United States\").",
1782
- "sourceLocation": {
1783
- "file": "src/lib/value/address.ts",
1784
- "line": 42
1785
- }
1381
+ "notes": "Full country name string (e.g. \"United States\")."
1786
1382
  },
1787
1383
  {
1788
1384
  "name": "CountryCodeString",
@@ -1796,11 +1392,7 @@
1796
1392
  "string",
1797
1393
  "dereekb-util:address"
1798
1394
  ],
1799
- "notes": "Country code string (e.g. \"US\").",
1800
- "sourceLocation": {
1801
- "file": "src/lib/value/address.ts",
1802
- "line": 52
1803
- }
1395
+ "notes": "Country code string (e.g. \"US\")."
1804
1396
  },
1805
1397
  {
1806
1398
  "name": "AddressLineString",
@@ -1814,11 +1406,7 @@
1814
1406
  "string",
1815
1407
  "dereekb-util:address"
1816
1408
  ],
1817
- "notes": "A single line in a street address.",
1818
- "sourceLocation": {
1819
- "file": "src/lib/value/address.ts",
1820
- "line": 62
1821
- }
1409
+ "notes": "A single line in a street address."
1822
1410
  },
1823
1411
  {
1824
1412
  "name": "ZipCodeString",
@@ -1832,11 +1420,7 @@
1832
1420
  "string",
1833
1421
  "dereekb-util:address"
1834
1422
  ],
1835
- "notes": "Postal/zip code string.",
1836
- "sourceLocation": {
1837
- "file": "src/lib/value/address.ts",
1838
- "line": 72
1839
- }
1423
+ "notes": "Postal/zip code string."
1840
1424
  },
1841
1425
  {
1842
1426
  "name": "CronExpression",
@@ -1849,11 +1433,7 @@
1849
1433
  "string",
1850
1434
  "dereekb-util:cron"
1851
1435
  ],
1852
- "notes": "A cron schedule expression string",
1853
- "sourceLocation": {
1854
- "file": "src/lib/value/cron.ts",
1855
- "line": 11
1856
- }
1436
+ "notes": "A cron schedule expression string"
1857
1437
  },
1858
1438
  {
1859
1439
  "name": "IndexNumber",
@@ -1866,11 +1446,7 @@
1866
1446
  "numeric",
1867
1447
  "reference"
1868
1448
  ],
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
- }
1449
+ "notes": "An integer that denotes which index an item is at.\n\nIs typically non-negative only."
1874
1450
  },
1875
1451
  {
1876
1452
  "name": "ModifierKey",
@@ -1883,11 +1459,7 @@
1883
1459
  "string",
1884
1460
  "identifier"
1885
1461
  ],
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
- }
1462
+ "notes": "String key that uniquely identifies a modifier within a {@link ModifierMap}."
1891
1463
  },
1892
1464
  {
1893
1465
  "name": "Pixels",
@@ -1900,11 +1472,7 @@
1900
1472
  "measurement",
1901
1473
  "numeric"
1902
1474
  ],
1903
- "notes": "Pixel count.",
1904
- "sourceLocation": {
1905
- "file": "src/lib/value/pixel.ts",
1906
- "line": 8
1907
- }
1475
+ "notes": "Pixel count."
1908
1476
  },
1909
1477
  {
1910
1478
  "name": "PixelsString",
@@ -1917,11 +1485,7 @@
1917
1485
  "measurement",
1918
1486
  "string"
1919
1487
  ],
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
- }
1488
+ "notes": "Pixel count as a string with a \"px\" suffix (e.g. \"100px\")."
1925
1489
  },
1926
1490
  {
1927
1491
  "name": "Latitude",
@@ -1934,11 +1498,7 @@
1934
1498
  "geo",
1935
1499
  "numeric"
1936
1500
  ],
1937
- "notes": "Latitude value in degrees, ranging from -90 to 90.",
1938
- "sourceLocation": {
1939
- "file": "src/lib/value/point.ts",
1940
- "line": 16
1941
- }
1501
+ "notes": "Latitude value in degrees, ranging from -90 to 90."
1942
1502
  },
1943
1503
  {
1944
1504
  "name": "Longitude",
@@ -1951,11 +1511,7 @@
1951
1511
  "geo",
1952
1512
  "numeric"
1953
1513
  ],
1954
- "notes": "Longitude value in degrees, ranging from -180 to 180.",
1955
- "sourceLocation": {
1956
- "file": "src/lib/value/point.ts",
1957
- "line": 25
1958
- }
1514
+ "notes": "Longitude value in degrees, ranging from -180 to 180."
1959
1515
  },
1960
1516
  {
1961
1517
  "name": "LatLngPoint",
@@ -1970,11 +1526,7 @@
1970
1526
  "guards": [
1971
1527
  "isLatLngPoint"
1972
1528
  ],
1973
- "notes": "A geographic point represented by latitude and longitude.",
1974
- "sourceLocation": {
1975
- "file": "src/lib/value/point.ts",
1976
- "line": 63
1977
- }
1529
+ "notes": "A geographic point represented by latitude and longitude."
1978
1530
  },
1979
1531
  {
1980
1532
  "name": "ZoomLevel",
@@ -1987,11 +1539,7 @@
1987
1539
  "measurement",
1988
1540
  "numeric"
1989
1541
  ],
1990
- "notes": "Camera zoom level.",
1991
- "sourceLocation": {
1992
- "file": "src/lib/value/zoom.ts",
1993
- "line": 8
1994
- }
1542
+ "notes": "Camera zoom level."
1995
1543
  }
1996
1544
  ]
1997
1545
  }