@dereekb/dbx-components-mcp 13.11.14 → 13.11.16
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dbx-components-mcp.js +3050 -1928
- package/generated/dereekb-date.utils.mcp.generated.json +220 -80
- package/generated/dereekb-dbx-core.filters.mcp.generated.json +1 -1
- package/generated/dereekb-dbx-web.ui-components.mcp.generated.json +165 -1
- package/generated/dereekb-firebase.model-snapshot-fields.mcp.generated.json +45 -45
- package/generated/dereekb-firebase.utils.mcp.generated.json +63 -63
- package/generated/dereekb-util.semantic-types.mcp.generated.json +2 -2
- package/generated/dereekb-util.utils.mcp.generated.json +632 -553
- package/generated/rule-catalog.generated.json +51 -3
- package/package.json +11 -11
|
@@ -269,17 +269,17 @@
|
|
|
269
269
|
{
|
|
270
270
|
"name": "input",
|
|
271
271
|
"type": "T[]",
|
|
272
|
-
"description": "-
|
|
272
|
+
"description": "- Source items to partition into consecutive runs.",
|
|
273
273
|
"optional": false
|
|
274
274
|
},
|
|
275
275
|
{
|
|
276
276
|
"name": "batchSize",
|
|
277
277
|
"type": "number",
|
|
278
|
-
"description": "-
|
|
278
|
+
"description": "- Upper bound on items per batch.",
|
|
279
279
|
"optional": false
|
|
280
280
|
}
|
|
281
281
|
],
|
|
282
|
-
"returns": "
|
|
282
|
+
"returns": "Consecutive batches tagged with their zero-based index.",
|
|
283
283
|
"tags": [
|
|
284
284
|
"array",
|
|
285
285
|
"batch",
|
|
@@ -399,7 +399,7 @@
|
|
|
399
399
|
"optional": false
|
|
400
400
|
}
|
|
401
401
|
],
|
|
402
|
-
"returns": "
|
|
402
|
+
"returns": "Tuples pairing each derived key with its source value.",
|
|
403
403
|
"tags": [
|
|
404
404
|
"grouping",
|
|
405
405
|
"key",
|
|
@@ -553,23 +553,23 @@
|
|
|
553
553
|
{
|
|
554
554
|
"name": "hashedValues",
|
|
555
555
|
"type": "string[]",
|
|
556
|
-
"description": "-
|
|
556
|
+
"description": "- Hashed inputs awaiting reverse lookup.",
|
|
557
557
|
"optional": false
|
|
558
558
|
},
|
|
559
559
|
{
|
|
560
560
|
"name": "decodeValues",
|
|
561
561
|
"type": "string[]",
|
|
562
|
-
"description": "-
|
|
562
|
+
"description": "- Plaintext candidates that may match one of the hashes.",
|
|
563
563
|
"optional": false
|
|
564
564
|
},
|
|
565
565
|
{
|
|
566
566
|
"name": "hashFn",
|
|
567
567
|
"type": "(value: string) => string",
|
|
568
|
-
"description": "-
|
|
568
|
+
"description": "- Deterministic hashing used to align the candidate set with the input hashes.",
|
|
569
569
|
"optional": false
|
|
570
570
|
}
|
|
571
571
|
],
|
|
572
|
-
"returns": "
|
|
572
|
+
"returns": "Plaintext recovered from `decodeValues`, dropping any hash that lacks a match.",
|
|
573
573
|
"tags": [
|
|
574
574
|
"hash",
|
|
575
575
|
"decode",
|
|
@@ -599,17 +599,17 @@
|
|
|
599
599
|
{
|
|
600
600
|
"name": "decodeValues",
|
|
601
601
|
"type": "string[]",
|
|
602
|
-
"description": "-
|
|
602
|
+
"description": "- Plaintext candidates whose hashes the map should index.",
|
|
603
603
|
"optional": false
|
|
604
604
|
},
|
|
605
605
|
{
|
|
606
606
|
"name": "hashFn",
|
|
607
607
|
"type": "(value: string) => string",
|
|
608
|
-
"description": "-
|
|
608
|
+
"description": "- Deterministic hashing used to compute each key.",
|
|
609
609
|
"optional": false
|
|
610
610
|
}
|
|
611
611
|
],
|
|
612
|
-
"returns": "
|
|
612
|
+
"returns": "Hash-to-plaintext lookup ready for reverse decoding.",
|
|
613
613
|
"tags": [
|
|
614
614
|
"hash",
|
|
615
615
|
"decode",
|
|
@@ -679,7 +679,7 @@
|
|
|
679
679
|
"optional": false
|
|
680
680
|
}
|
|
681
681
|
],
|
|
682
|
-
"returns": "
|
|
682
|
+
"returns": "Reusable extractor that normalizes single or batch input into a flat key list (nullish keys dropped).",
|
|
683
683
|
"tags": [
|
|
684
684
|
"key",
|
|
685
685
|
"read",
|
|
@@ -713,7 +713,7 @@
|
|
|
713
713
|
"optional": false
|
|
714
714
|
}
|
|
715
715
|
],
|
|
716
|
-
"returns": "
|
|
716
|
+
"returns": "Reusable extractor that collects keys into a deduped Set.",
|
|
717
717
|
"tags": [
|
|
718
718
|
"key",
|
|
719
719
|
"read",
|
|
@@ -777,17 +777,17 @@
|
|
|
777
777
|
{
|
|
778
778
|
"name": "ascendingCompareFn",
|
|
779
779
|
"type": "AscendingSortCompareFunction<T>",
|
|
780
|
-
"description": "-
|
|
780
|
+
"description": "- A comparison function that sorts in ascending order.",
|
|
781
781
|
"optional": false
|
|
782
782
|
},
|
|
783
783
|
{
|
|
784
784
|
"name": "order",
|
|
785
785
|
"type": "SortingOrder",
|
|
786
|
-
"description": "-
|
|
786
|
+
"description": "- The desired sort direction; defaults to 'asc'.",
|
|
787
787
|
"optional": true
|
|
788
788
|
}
|
|
789
789
|
],
|
|
790
|
-
"returns": "
|
|
790
|
+
"returns": "The original function if ascending, or a reversed version if descending.",
|
|
791
791
|
"tags": [
|
|
792
792
|
"sort",
|
|
793
793
|
"order",
|
|
@@ -864,7 +864,7 @@
|
|
|
864
864
|
"optional": false
|
|
865
865
|
}
|
|
866
866
|
],
|
|
867
|
-
"returns": "
|
|
867
|
+
"returns": "Returns `{ min, max }` or `null` for empty iterables.",
|
|
868
868
|
"tags": [
|
|
869
869
|
"sort",
|
|
870
870
|
"min",
|
|
@@ -1034,11 +1034,11 @@
|
|
|
1034
1034
|
{
|
|
1035
1035
|
"name": "factory",
|
|
1036
1036
|
"type": "Factory<T> | FactoryWithIndex<T>",
|
|
1037
|
-
"description": "-
|
|
1037
|
+
"description": "- Per-item producer invoked once per requested element.",
|
|
1038
1038
|
"optional": false
|
|
1039
1039
|
}
|
|
1040
1040
|
],
|
|
1041
|
-
"returns": "
|
|
1041
|
+
"returns": "Count-driven generator that materializes the requested number of items.",
|
|
1042
1042
|
"tags": [
|
|
1043
1043
|
"array",
|
|
1044
1044
|
"factory",
|
|
@@ -1066,11 +1066,11 @@
|
|
|
1066
1066
|
{
|
|
1067
1067
|
"name": "factory",
|
|
1068
1068
|
"type": "FactoryWithRequiredInput<O, I>",
|
|
1069
|
-
"description": "-
|
|
1069
|
+
"description": "- Per-element producer invoked with each input value plus its index.",
|
|
1070
1070
|
"optional": false
|
|
1071
1071
|
}
|
|
1072
1072
|
],
|
|
1073
|
-
"returns": "
|
|
1073
|
+
"returns": "Adapter that runs `factory` against every input element to produce the mapped output array.",
|
|
1074
1074
|
"tags": [
|
|
1075
1075
|
"array",
|
|
1076
1076
|
"factory",
|
|
@@ -1098,17 +1098,17 @@
|
|
|
1098
1098
|
{
|
|
1099
1099
|
"name": "input",
|
|
1100
1100
|
"type": "T[]",
|
|
1101
|
-
"description": "-
|
|
1101
|
+
"description": "- Source items considered for best-fit selection; not mutated.",
|
|
1102
1102
|
"optional": false
|
|
1103
1103
|
},
|
|
1104
1104
|
{
|
|
1105
1105
|
"name": "config",
|
|
1106
1106
|
"type": "BestFitConfig<T>",
|
|
1107
|
-
"description": "-
|
|
1107
|
+
"description": "- Strategy describing eligibility, comparison, and non-winner transformation.",
|
|
1108
1108
|
"optional": false
|
|
1109
1109
|
}
|
|
1110
1110
|
],
|
|
1111
|
-
"returns": "
|
|
1111
|
+
"returns": "Fresh array containing the chosen winner alongside transformed runners-up.",
|
|
1112
1112
|
"tags": [
|
|
1113
1113
|
"array",
|
|
1114
1114
|
"best-fit",
|
|
@@ -1138,17 +1138,17 @@
|
|
|
1138
1138
|
{
|
|
1139
1139
|
"name": "input",
|
|
1140
1140
|
"type": "T[]",
|
|
1141
|
-
"description": "-
|
|
1141
|
+
"description": "- Mutable array whose runners-up should be rewritten in place.",
|
|
1142
1142
|
"optional": false
|
|
1143
1143
|
},
|
|
1144
1144
|
{
|
|
1145
1145
|
"name": "config",
|
|
1146
1146
|
"type": "BestFitConfig<T>",
|
|
1147
|
-
"description": "-
|
|
1147
|
+
"description": "- Strategy describing eligibility, comparison, and non-winner transformation.",
|
|
1148
1148
|
"optional": false
|
|
1149
1149
|
}
|
|
1150
1150
|
],
|
|
1151
|
-
"returns": "
|
|
1151
|
+
"returns": "Same `input` reference after the runner-up replacements.",
|
|
1152
1152
|
"tags": [
|
|
1153
1153
|
"array",
|
|
1154
1154
|
"best-fit",
|
|
@@ -1179,17 +1179,17 @@
|
|
|
1179
1179
|
{
|
|
1180
1180
|
"name": "decisionFunction",
|
|
1181
1181
|
"type": "DecisionFunction<I>",
|
|
1182
|
-
"description": "-
|
|
1182
|
+
"description": "- Predicate used to decide whether each iterated item flows through.",
|
|
1183
1183
|
"optional": false
|
|
1184
1184
|
},
|
|
1185
1185
|
{
|
|
1186
1186
|
"name": "mapFunction",
|
|
1187
1187
|
"type": "MapFunction<I, O>",
|
|
1188
|
-
"description": "-
|
|
1188
|
+
"description": "- Transform applied to every included item.",
|
|
1189
1189
|
"optional": false
|
|
1190
1190
|
}
|
|
1191
1191
|
],
|
|
1192
|
-
"returns": "
|
|
1192
|
+
"returns": "Reusable filter-then-map operator over any iterable input.",
|
|
1193
1193
|
"tags": [
|
|
1194
1194
|
"array",
|
|
1195
1195
|
"filter",
|
|
@@ -1228,7 +1228,7 @@
|
|
|
1228
1228
|
"optional": false
|
|
1229
1229
|
}
|
|
1230
1230
|
],
|
|
1231
|
-
"returns": "
|
|
1231
|
+
"returns": "Predicate operating on whole arrays driven by the configured aggregation mode.",
|
|
1232
1232
|
"tags": [
|
|
1233
1233
|
"array",
|
|
1234
1234
|
"decision",
|
|
@@ -1304,11 +1304,11 @@
|
|
|
1304
1304
|
{
|
|
1305
1305
|
"name": "inputRange",
|
|
1306
1306
|
"type": "IndexRangeInput",
|
|
1307
|
-
"description": "-
|
|
1307
|
+
"description": "- Range boundaries to bake into the returned slicer.",
|
|
1308
1308
|
"optional": false
|
|
1309
1309
|
}
|
|
1310
1310
|
],
|
|
1311
|
-
"returns": "
|
|
1311
|
+
"returns": "Reusable slicer that extracts the configured range from any input array.",
|
|
1312
1312
|
"tags": [
|
|
1313
1313
|
"array",
|
|
1314
1314
|
"slice",
|
|
@@ -1476,11 +1476,11 @@
|
|
|
1476
1476
|
{
|
|
1477
1477
|
"name": "config",
|
|
1478
1478
|
"type": "RandomArrayFactoryConfig<T>",
|
|
1479
|
-
"description": "-
|
|
1479
|
+
"description": "- Configuration containing the make function and random number source.",
|
|
1480
1480
|
"optional": false
|
|
1481
1481
|
}
|
|
1482
1482
|
],
|
|
1483
|
-
"returns": "
|
|
1483
|
+
"returns": "A factory that produces arrays of random length, optionally accepting a specific count override.",
|
|
1484
1484
|
"tags": [
|
|
1485
1485
|
"array",
|
|
1486
1486
|
"random",
|
|
@@ -1507,11 +1507,11 @@
|
|
|
1507
1507
|
{
|
|
1508
1508
|
"name": "values",
|
|
1509
1509
|
"type": "T[]",
|
|
1510
|
-
"description": "-
|
|
1510
|
+
"description": "- Array of values to randomly pick from.",
|
|
1511
1511
|
"optional": false
|
|
1512
1512
|
}
|
|
1513
1513
|
],
|
|
1514
|
-
"returns": "
|
|
1514
|
+
"returns": "A callable factory that returns a random value from the array on each invocation.",
|
|
1515
1515
|
"tags": [
|
|
1516
1516
|
"array",
|
|
1517
1517
|
"random",
|
|
@@ -1539,11 +1539,11 @@
|
|
|
1539
1539
|
{
|
|
1540
1540
|
"name": "values",
|
|
1541
1541
|
"type": "T[]",
|
|
1542
|
-
"description": "-
|
|
1542
|
+
"description": "- Array to generate a random index for.",
|
|
1543
1543
|
"optional": false
|
|
1544
1544
|
}
|
|
1545
1545
|
],
|
|
1546
|
-
"returns": "
|
|
1546
|
+
"returns": "A random valid index within the array, or 0 if the array is empty.",
|
|
1547
1547
|
"tags": [
|
|
1548
1548
|
"array",
|
|
1549
1549
|
"random",
|
|
@@ -1569,11 +1569,11 @@
|
|
|
1569
1569
|
{
|
|
1570
1570
|
"name": "values",
|
|
1571
1571
|
"type": "T[]",
|
|
1572
|
-
"description": "-
|
|
1572
|
+
"description": "- Array to pick a random item from.",
|
|
1573
1573
|
"optional": false
|
|
1574
1574
|
}
|
|
1575
1575
|
],
|
|
1576
|
-
"returns": "
|
|
1576
|
+
"returns": "A randomly selected item from the array.",
|
|
1577
1577
|
"tags": [
|
|
1578
1578
|
"array",
|
|
1579
1579
|
"random",
|
|
@@ -1602,17 +1602,17 @@
|
|
|
1602
1602
|
{
|
|
1603
1603
|
"name": "values",
|
|
1604
1604
|
"type": "T[]",
|
|
1605
|
-
"description": "-
|
|
1605
|
+
"description": "- Source whose entries are kept only when present in the second array.",
|
|
1606
1606
|
"optional": false
|
|
1607
1607
|
},
|
|
1608
1608
|
{
|
|
1609
1609
|
"name": "secondArray",
|
|
1610
1610
|
"type": "T[]",
|
|
1611
|
-
"description": "-
|
|
1611
|
+
"description": "- Allowed-values gate used for the intersection check.",
|
|
1612
1612
|
"optional": false
|
|
1613
1613
|
}
|
|
1614
1614
|
],
|
|
1615
|
-
"returns": "
|
|
1615
|
+
"returns": "Intersection of `values` and `secondArray`, ordered like `values`.",
|
|
1616
1616
|
"tags": [
|
|
1617
1617
|
"array",
|
|
1618
1618
|
"set",
|
|
@@ -1642,17 +1642,17 @@
|
|
|
1642
1642
|
{
|
|
1643
1643
|
"name": "values",
|
|
1644
1644
|
"type": "T[]",
|
|
1645
|
-
"description": "-
|
|
1645
|
+
"description": "- Source whose entries are kept only when absent from the second array.",
|
|
1646
1646
|
"optional": false
|
|
1647
1647
|
},
|
|
1648
1648
|
{
|
|
1649
1649
|
"name": "secondArray",
|
|
1650
1650
|
"type": "T[]",
|
|
1651
|
-
"description": "-
|
|
1651
|
+
"description": "- Excluded-values gate used for the difference check.",
|
|
1652
1652
|
"optional": false
|
|
1653
1653
|
}
|
|
1654
1654
|
],
|
|
1655
|
-
"returns": "
|
|
1655
|
+
"returns": "Set difference `values \\ secondArray`, ordered like `values`.",
|
|
1656
1656
|
"tags": [
|
|
1657
1657
|
"array",
|
|
1658
1658
|
"set",
|
|
@@ -1681,11 +1681,11 @@
|
|
|
1681
1681
|
{
|
|
1682
1682
|
"name": "values",
|
|
1683
1683
|
"type": "T[]",
|
|
1684
|
-
"description": "-
|
|
1684
|
+
"description": "- Source to scan for any repeated entry.",
|
|
1685
1685
|
"optional": false
|
|
1686
1686
|
}
|
|
1687
1687
|
],
|
|
1688
|
-
"returns": "
|
|
1688
|
+
"returns": "True when at least one value appears more than once; otherwise false.",
|
|
1689
1689
|
"tags": [
|
|
1690
1690
|
"array",
|
|
1691
1691
|
"duplicate",
|
|
@@ -1714,11 +1714,11 @@
|
|
|
1714
1714
|
{
|
|
1715
1715
|
"name": "values",
|
|
1716
1716
|
"type": "T[]",
|
|
1717
|
-
"description": "-
|
|
1717
|
+
"description": "- Source to scan left-to-right for the first repeat.",
|
|
1718
1718
|
"optional": false
|
|
1719
1719
|
}
|
|
1720
1720
|
],
|
|
1721
|
-
"returns": "
|
|
1721
|
+
"returns": "Index of the first value that matches an earlier one, or `-1` when all values are unique.",
|
|
1722
1722
|
"tags": [
|
|
1723
1723
|
"array",
|
|
1724
1724
|
"duplicate",
|
|
@@ -1748,11 +1748,11 @@
|
|
|
1748
1748
|
{
|
|
1749
1749
|
"name": "arrayOrValue",
|
|
1750
1750
|
"type": "Maybe<ArrayOrValue<T>>",
|
|
1751
|
-
"description": "-
|
|
1751
|
+
"description": "- Single value or array to convert.",
|
|
1752
1752
|
"optional": false
|
|
1753
1753
|
}
|
|
1754
1754
|
],
|
|
1755
|
-
"returns": "
|
|
1755
|
+
"returns": "An array with at least one element, or undefined if the result would be empty.",
|
|
1756
1756
|
"tags": [
|
|
1757
1757
|
"array",
|
|
1758
1758
|
"non-empty",
|
|
@@ -1783,11 +1783,11 @@
|
|
|
1783
1783
|
{
|
|
1784
1784
|
"name": "arrayOrValue",
|
|
1785
1785
|
"type": "Maybe<ArrayOrValue<T>>",
|
|
1786
|
-
"description": "-
|
|
1786
|
+
"description": "- Single value, array, or nullish value to convert.",
|
|
1787
1787
|
"optional": false
|
|
1788
1788
|
}
|
|
1789
1789
|
],
|
|
1790
|
-
"returns": "
|
|
1790
|
+
"returns": "The input wrapped in an array, the input array itself, or an empty array if nullish.",
|
|
1791
1791
|
"tags": [
|
|
1792
1792
|
"array",
|
|
1793
1793
|
"convert",
|
|
@@ -1817,11 +1817,11 @@
|
|
|
1817
1817
|
{
|
|
1818
1818
|
"name": "arrayOrValue",
|
|
1819
1819
|
"type": "ArrayOrValue<T>",
|
|
1820
|
-
"description": "-
|
|
1820
|
+
"description": "- Single value or array to convert.",
|
|
1821
1821
|
"optional": false
|
|
1822
1822
|
}
|
|
1823
1823
|
],
|
|
1824
|
-
"returns": "
|
|
1824
|
+
"returns": "The input array unchanged, or a new single-element array wrapping the input value.",
|
|
1825
1825
|
"tags": [
|
|
1826
1826
|
"array",
|
|
1827
1827
|
"convert",
|
|
@@ -1849,11 +1849,11 @@
|
|
|
1849
1849
|
{
|
|
1850
1850
|
"name": "input",
|
|
1851
1851
|
"type": "ArrayOrValue<T>",
|
|
1852
|
-
"description": "-
|
|
1852
|
+
"description": "- Single value or array to retrieve from.",
|
|
1853
1853
|
"optional": false
|
|
1854
1854
|
}
|
|
1855
1855
|
],
|
|
1856
|
-
"returns": "
|
|
1856
|
+
"returns": "The first element of the array, or the input value itself.",
|
|
1857
1857
|
"tags": [
|
|
1858
1858
|
"array",
|
|
1859
1859
|
"first",
|
|
@@ -1881,11 +1881,11 @@
|
|
|
1881
1881
|
{
|
|
1882
1882
|
"name": "input",
|
|
1883
1883
|
"type": "ArrayOrValue<T>",
|
|
1884
|
-
"description": "-
|
|
1884
|
+
"description": "- Single value or array to retrieve from.",
|
|
1885
1885
|
"optional": false
|
|
1886
1886
|
}
|
|
1887
1887
|
],
|
|
1888
|
-
"returns": "
|
|
1888
|
+
"returns": "The last element of the array, or the input value itself.",
|
|
1889
1889
|
"tags": [
|
|
1890
1890
|
"array",
|
|
1891
1891
|
"last",
|
|
@@ -1913,11 +1913,11 @@
|
|
|
1913
1913
|
{
|
|
1914
1914
|
"name": "input",
|
|
1915
1915
|
"type": "ArrayOrValue<T>",
|
|
1916
|
-
"description": "-
|
|
1916
|
+
"description": "- Single value or array to retrieve from.",
|
|
1917
1917
|
"optional": false
|
|
1918
1918
|
}
|
|
1919
1919
|
],
|
|
1920
|
-
"returns": "
|
|
1920
|
+
"returns": "A two-element tuple of the first and last values.",
|
|
1921
1921
|
"tags": [
|
|
1922
1922
|
"array",
|
|
1923
1923
|
"first",
|
|
@@ -1949,17 +1949,17 @@
|
|
|
1949
1949
|
{
|
|
1950
1950
|
"name": "input",
|
|
1951
1951
|
"type": "ArrayOrValue<T>",
|
|
1952
|
-
"description": "-
|
|
1952
|
+
"description": "- Single value or array to retrieve from.",
|
|
1953
1953
|
"optional": false
|
|
1954
1954
|
},
|
|
1955
1955
|
{
|
|
1956
1956
|
"name": "index",
|
|
1957
1957
|
"type": "number",
|
|
1958
|
-
"description": "-
|
|
1958
|
+
"description": "- Zero-based index of the element to retrieve.",
|
|
1959
1959
|
"optional": false
|
|
1960
1960
|
}
|
|
1961
1961
|
],
|
|
1962
|
-
"returns": "
|
|
1962
|
+
"returns": "The element at the specified index, or the input value itself if not an array.",
|
|
1963
1963
|
"tags": [
|
|
1964
1964
|
"array",
|
|
1965
1965
|
"index",
|
|
@@ -1987,11 +1987,11 @@
|
|
|
1987
1987
|
{
|
|
1988
1988
|
"name": "arrays",
|
|
1989
1989
|
"type": "Maybe<T[]>[]",
|
|
1990
|
-
"description": "-
|
|
1990
|
+
"description": "- Arrays to concatenate; nullish entries are ignored.",
|
|
1991
1991
|
"optional": true
|
|
1992
1992
|
}
|
|
1993
1993
|
],
|
|
1994
|
-
"returns": "
|
|
1994
|
+
"returns": "A single flattened array containing all elements from the non-nullish input arrays.",
|
|
1995
1995
|
"tags": [
|
|
1996
1996
|
"array",
|
|
1997
1997
|
"concat",
|
|
@@ -2020,11 +2020,11 @@
|
|
|
2020
2020
|
{
|
|
2021
2021
|
"name": "array",
|
|
2022
2022
|
"type": "Maybe<T[]>[]",
|
|
2023
|
-
"description": "-
|
|
2023
|
+
"description": "- Two-dimensional array to flatten, may contain nullish entries.",
|
|
2024
2024
|
"optional": false
|
|
2025
2025
|
}
|
|
2026
2026
|
],
|
|
2027
|
-
"returns": "
|
|
2027
|
+
"returns": "A single-dimensional array with all elements from the non-nullish inner arrays.",
|
|
2028
2028
|
"tags": [
|
|
2029
2029
|
"array",
|
|
2030
2030
|
"flatten",
|
|
@@ -2053,11 +2053,11 @@
|
|
|
2053
2053
|
{
|
|
2054
2054
|
"name": "input",
|
|
2055
2055
|
"type": "Maybe<T[]>",
|
|
2056
|
-
"description": "-
|
|
2056
|
+
"description": "- Array to copy, or nullish.",
|
|
2057
2057
|
"optional": false
|
|
2058
2058
|
}
|
|
2059
2059
|
],
|
|
2060
|
-
"returns": "
|
|
2060
|
+
"returns": "A new array with the same elements, or an empty array if input is nullish.",
|
|
2061
2061
|
"tags": [
|
|
2062
2062
|
"array",
|
|
2063
2063
|
"copy",
|
|
@@ -2083,11 +2083,11 @@
|
|
|
2083
2083
|
{
|
|
2084
2084
|
"name": "arrays",
|
|
2085
2085
|
"type": "Maybe<T[]>[]",
|
|
2086
|
-
"description": "-
|
|
2086
|
+
"description": "- Arrays to merge; nullish entries are skipped.",
|
|
2087
2087
|
"optional": false
|
|
2088
2088
|
}
|
|
2089
2089
|
],
|
|
2090
|
-
"returns": "
|
|
2090
|
+
"returns": "A new array containing all elements from the provided arrays.",
|
|
2091
2091
|
"tags": [
|
|
2092
2092
|
"array",
|
|
2093
2093
|
"merge",
|
|
@@ -2114,17 +2114,17 @@
|
|
|
2114
2114
|
{
|
|
2115
2115
|
"name": "values",
|
|
2116
2116
|
"type": "T[]",
|
|
2117
|
-
"description": "-
|
|
2117
|
+
"description": "- Source array to take from.",
|
|
2118
2118
|
"optional": false
|
|
2119
2119
|
},
|
|
2120
2120
|
{
|
|
2121
2121
|
"name": "maxToTake",
|
|
2122
2122
|
"type": "number",
|
|
2123
|
-
"description": "-
|
|
2123
|
+
"description": "- Maximum number of elements to take from the front.",
|
|
2124
2124
|
"optional": false
|
|
2125
2125
|
}
|
|
2126
2126
|
],
|
|
2127
|
-
"returns": "
|
|
2127
|
+
"returns": "A new array containing at most maxToTake elements from the front.",
|
|
2128
2128
|
"tags": [
|
|
2129
2129
|
"array",
|
|
2130
2130
|
"take",
|
|
@@ -2152,17 +2152,17 @@
|
|
|
2152
2152
|
{
|
|
2153
2153
|
"name": "values",
|
|
2154
2154
|
"type": "T[]",
|
|
2155
|
-
"description": "
|
|
2155
|
+
"description": "- Source items to partition into front + remaining halves.",
|
|
2156
2156
|
"optional": false
|
|
2157
2157
|
},
|
|
2158
2158
|
{
|
|
2159
2159
|
"name": "maxToTake",
|
|
2160
2160
|
"type": "number",
|
|
2161
|
-
"description": "
|
|
2161
|
+
"description": "- Upper bound on how many entries to take from the start.",
|
|
2162
2162
|
"optional": false
|
|
2163
2163
|
}
|
|
2164
2164
|
],
|
|
2165
|
-
"returns": "
|
|
2165
|
+
"returns": "Pair containing the leading slice plus everything left over.",
|
|
2166
2166
|
"tags": [
|
|
2167
2167
|
"array",
|
|
2168
2168
|
"split",
|
|
@@ -2189,19 +2189,19 @@
|
|
|
2189
2189
|
{
|
|
2190
2190
|
"name": "values",
|
|
2191
2191
|
"type": "T[]",
|
|
2192
|
-
"description": "Values to take from.",
|
|
2192
|
+
"description": "- Values to take from.",
|
|
2193
2193
|
"optional": false
|
|
2194
2194
|
},
|
|
2195
2195
|
{
|
|
2196
2196
|
"name": "maxToTake",
|
|
2197
2197
|
"type": "number",
|
|
2198
|
-
"description": "Max number of values to take from the end of the input array.",
|
|
2198
|
+
"description": "- Max number of values to take from the end of the input array.",
|
|
2199
2199
|
"optional": false
|
|
2200
2200
|
},
|
|
2201
2201
|
{
|
|
2202
2202
|
"name": "keepFromFront",
|
|
2203
2203
|
"type": "number",
|
|
2204
|
-
"description": "Number of values to retain in the front of the array. These are not taken.",
|
|
2204
|
+
"description": "- Number of values to retain in the front of the array. These are not taken.",
|
|
2205
2205
|
"optional": true
|
|
2206
2206
|
}
|
|
2207
2207
|
],
|
|
@@ -2234,11 +2234,11 @@
|
|
|
2234
2234
|
{
|
|
2235
2235
|
"name": "array",
|
|
2236
2236
|
"type": "T[][]",
|
|
2237
|
-
"description": "-
|
|
2237
|
+
"description": "- Two-dimensional array whose elements are counted.",
|
|
2238
2238
|
"optional": false
|
|
2239
2239
|
}
|
|
2240
2240
|
],
|
|
2241
|
-
"returns": "
|
|
2241
|
+
"returns": "The total number of elements across all inner arrays.",
|
|
2242
2242
|
"tags": [
|
|
2243
2243
|
"array",
|
|
2244
2244
|
"count",
|
|
@@ -2267,17 +2267,17 @@
|
|
|
2267
2267
|
{
|
|
2268
2268
|
"name": "array",
|
|
2269
2269
|
"type": "T[]",
|
|
2270
|
-
"description": "-
|
|
2270
|
+
"description": "- Source array to copy from.",
|
|
2271
2271
|
"optional": false
|
|
2272
2272
|
},
|
|
2273
2273
|
{
|
|
2274
2274
|
"name": "removeIndexes",
|
|
2275
2275
|
"type": "IterableOrValue<number>",
|
|
2276
|
-
"description": "-
|
|
2276
|
+
"description": "- Indexes of elements to exclude from the copy.",
|
|
2277
2277
|
"optional": false
|
|
2278
2278
|
}
|
|
2279
2279
|
],
|
|
2280
|
-
"returns": "
|
|
2280
|
+
"returns": "A new array without the elements at the specified indexes.",
|
|
2281
2281
|
"tags": [
|
|
2282
2282
|
"array",
|
|
2283
2283
|
"remove",
|
|
@@ -2571,7 +2571,7 @@
|
|
|
2571
2571
|
"optional": false
|
|
2572
2572
|
}
|
|
2573
2573
|
],
|
|
2574
|
-
"returns": "
|
|
2574
|
+
"returns": "Reusable filter operator that drops nullish entries and applies the predicate to the rest.",
|
|
2575
2575
|
"tags": [
|
|
2576
2576
|
"array",
|
|
2577
2577
|
"filter",
|
|
@@ -2658,11 +2658,11 @@
|
|
|
2658
2658
|
{
|
|
2659
2659
|
"name": "defaults",
|
|
2660
2660
|
"type": "AuthRoleClaimsFactoryDefaults",
|
|
2661
|
-
"description": "- Optional default values for claim presence and absence",
|
|
2661
|
+
"description": "- Optional default values for claim presence and absence.",
|
|
2662
2662
|
"optional": true
|
|
2663
2663
|
}
|
|
2664
2664
|
],
|
|
2665
|
-
"returns": "A service with `toClaims` and `toRoles` conversion functions",
|
|
2665
|
+
"returns": "A service with `toClaims` and `toRoles` conversion functions.",
|
|
2666
2666
|
"tags": [
|
|
2667
2667
|
"auth",
|
|
2668
2668
|
"role",
|
|
@@ -2756,11 +2756,11 @@
|
|
|
2756
2756
|
{
|
|
2757
2757
|
"name": "addresses",
|
|
2758
2758
|
"type": "EmailAddress[]",
|
|
2759
|
-
"description": "- Array of email addresses to extract domains from",
|
|
2759
|
+
"description": "- Array of email addresses to extract domains from.",
|
|
2760
2760
|
"optional": false
|
|
2761
2761
|
}
|
|
2762
2762
|
],
|
|
2763
|
-
"returns": "Array of unique lowercase domain strings",
|
|
2763
|
+
"returns": "Array of unique lowercase domain strings.",
|
|
2764
2764
|
"tags": [
|
|
2765
2765
|
"email",
|
|
2766
2766
|
"domain",
|
|
@@ -2793,11 +2793,11 @@
|
|
|
2793
2793
|
{
|
|
2794
2794
|
"name": "address",
|
|
2795
2795
|
"type": "EmailAddress",
|
|
2796
|
-
"description": "- The email address to extract the domain from",
|
|
2796
|
+
"description": "- The email address to extract the domain from.",
|
|
2797
2797
|
"optional": false
|
|
2798
2798
|
}
|
|
2799
2799
|
],
|
|
2800
|
-
"returns": "The lowercase domain string",
|
|
2800
|
+
"returns": "The lowercase domain string.",
|
|
2801
2801
|
"tags": [
|
|
2802
2802
|
"email",
|
|
2803
2803
|
"domain",
|
|
@@ -2828,11 +2828,11 @@
|
|
|
2828
2828
|
{
|
|
2829
2829
|
"name": "urlLikeInput",
|
|
2830
2830
|
"type": "string | EmailAddress | EmailAddressDomain",
|
|
2831
|
-
"description": "- A URL, email address, or domain string",
|
|
2831
|
+
"description": "- A URL, email address, or domain string.",
|
|
2832
2832
|
"optional": false
|
|
2833
2833
|
}
|
|
2834
2834
|
],
|
|
2835
|
-
"returns": "The extracted domain",
|
|
2835
|
+
"returns": "The extracted domain.",
|
|
2836
2836
|
"tags": [
|
|
2837
2837
|
"email",
|
|
2838
2838
|
"domain",
|
|
@@ -2866,11 +2866,11 @@
|
|
|
2866
2866
|
{
|
|
2867
2867
|
"name": "participant",
|
|
2868
2868
|
"type": "EmailParticipant",
|
|
2869
|
-
"description": "- The email participant to convert",
|
|
2869
|
+
"description": "- The email participant to convert.",
|
|
2870
2870
|
"optional": false
|
|
2871
2871
|
}
|
|
2872
2872
|
],
|
|
2873
|
-
"returns": "A formatted string representation of the participant",
|
|
2873
|
+
"returns": "A formatted string representation of the participant.",
|
|
2874
2874
|
"tags": [
|
|
2875
2875
|
"email",
|
|
2876
2876
|
"participant",
|
|
@@ -2901,11 +2901,11 @@
|
|
|
2901
2901
|
{
|
|
2902
2902
|
"name": "participantString",
|
|
2903
2903
|
"type": "EmailParticipantString",
|
|
2904
|
-
"description": "-
|
|
2904
|
+
"description": "- Serialized participant in `name<email>` or `<email>` form.",
|
|
2905
2905
|
"optional": false
|
|
2906
2906
|
}
|
|
2907
2907
|
],
|
|
2908
|
-
"returns": "
|
|
2908
|
+
"returns": "Parsed participant pairing the optional display name with the extracted address.",
|
|
2909
2909
|
"tags": [
|
|
2910
2910
|
"email",
|
|
2911
2911
|
"participant",
|
|
@@ -2941,7 +2941,7 @@
|
|
|
2941
2941
|
"optional": false
|
|
2942
2942
|
}
|
|
2943
2943
|
],
|
|
2944
|
-
"returns": "A combined array of EmailParticipant objects",
|
|
2944
|
+
"returns": "A combined array of EmailParticipant objects.",
|
|
2945
2945
|
"tags": [
|
|
2946
2946
|
"email",
|
|
2947
2947
|
"participant",
|
|
@@ -2973,11 +2973,11 @@
|
|
|
2973
2973
|
{
|
|
2974
2974
|
"name": "inputConfig",
|
|
2975
2975
|
"type": "RandomEmailFactoryConfig",
|
|
2976
|
-
"description": "- Optional configuration overrides",
|
|
2976
|
+
"description": "- Optional configuration overrides.",
|
|
2977
2977
|
"optional": true
|
|
2978
2978
|
}
|
|
2979
2979
|
],
|
|
2980
|
-
"returns": "A factory function that produces random email address strings",
|
|
2980
|
+
"returns": "A factory function that produces random email address strings.",
|
|
2981
2981
|
"tags": [
|
|
2982
2982
|
"contact",
|
|
2983
2983
|
"email",
|
|
@@ -3004,11 +3004,11 @@
|
|
|
3004
3004
|
{
|
|
3005
3005
|
"name": "inputConfig",
|
|
3006
3006
|
"type": "RandomPhoneNumberFactoryConfig",
|
|
3007
|
-
"description": "- Optional configuration overrides",
|
|
3007
|
+
"description": "- Optional configuration overrides.",
|
|
3008
3008
|
"optional": true
|
|
3009
3009
|
}
|
|
3010
3010
|
],
|
|
3011
|
-
"returns": "A factory function that produces random E.164 phone number strings",
|
|
3011
|
+
"returns": "A factory function that produces random E.164 phone number strings.",
|
|
3012
3012
|
"tags": [
|
|
3013
3013
|
"contact",
|
|
3014
3014
|
"phone",
|
|
@@ -3063,11 +3063,11 @@
|
|
|
3063
3063
|
{
|
|
3064
3064
|
"name": "input",
|
|
3065
3065
|
"type": "string",
|
|
3066
|
-
"description": "-
|
|
3066
|
+
"description": "- Value to test against the ISO8601 date string pattern.",
|
|
3067
3067
|
"optional": false
|
|
3068
3068
|
}
|
|
3069
3069
|
],
|
|
3070
|
-
"returns": "True
|
|
3070
|
+
"returns": "True when the input matches the canonical ISO8601 date layout.",
|
|
3071
3071
|
"tags": [
|
|
3072
3072
|
"date",
|
|
3073
3073
|
"iso8601",
|
|
@@ -3119,11 +3119,11 @@
|
|
|
3119
3119
|
{
|
|
3120
3120
|
"name": "input",
|
|
3121
3121
|
"type": "string",
|
|
3122
|
-
"description": "-
|
|
3122
|
+
"description": "- Value to test against the UTC-formatted date string pattern.",
|
|
3123
3123
|
"optional": false
|
|
3124
3124
|
}
|
|
3125
3125
|
],
|
|
3126
|
-
"returns": "True
|
|
3126
|
+
"returns": "True when the input matches the canonical UTC date layout.",
|
|
3127
3127
|
"tags": [
|
|
3128
3128
|
"date",
|
|
3129
3129
|
"utc",
|
|
@@ -3151,17 +3151,17 @@
|
|
|
3151
3151
|
{
|
|
3152
3152
|
"name": "a",
|
|
3153
3153
|
"type": "Maybe<Partial<TimezoneStringRef>>",
|
|
3154
|
-
"description": "- First object that may contain a timezone reference",
|
|
3154
|
+
"description": "- First object that may contain a timezone reference.",
|
|
3155
3155
|
"optional": false
|
|
3156
3156
|
},
|
|
3157
3157
|
{
|
|
3158
3158
|
"name": "b",
|
|
3159
3159
|
"type": "Maybe<Partial<TimezoneStringRef>>",
|
|
3160
|
-
"description": "- Second object that may contain a timezone reference",
|
|
3160
|
+
"description": "- Second object that may contain a timezone reference.",
|
|
3161
3161
|
"optional": false
|
|
3162
3162
|
}
|
|
3163
3163
|
],
|
|
3164
|
-
"returns": "True if both objects have the same timezone or neither has a timezone set",
|
|
3164
|
+
"returns": "True if both objects have the same timezone or neither has a timezone set.",
|
|
3165
3165
|
"tags": [
|
|
3166
3166
|
"date",
|
|
3167
3167
|
"timezone",
|
|
@@ -3296,11 +3296,11 @@
|
|
|
3296
3296
|
{
|
|
3297
3297
|
"name": "date",
|
|
3298
3298
|
"type": "Date",
|
|
3299
|
-
"description": "-
|
|
3299
|
+
"description": "- Reference instant whose UTC calendar day should be anchored.",
|
|
3300
3300
|
"optional": false
|
|
3301
3301
|
}
|
|
3302
3302
|
],
|
|
3303
|
-
"returns": "
|
|
3303
|
+
"returns": "Midnight UTC of the same UTC day as `date`.",
|
|
3304
3304
|
"tags": [
|
|
3305
3305
|
"date",
|
|
3306
3306
|
"utc",
|
|
@@ -3331,11 +3331,11 @@
|
|
|
3331
3331
|
{
|
|
3332
3332
|
"name": "date",
|
|
3333
3333
|
"type": "Date",
|
|
3334
|
-
"description": "-
|
|
3334
|
+
"description": "- Reference instant whose system-local calendar day should be anchored.",
|
|
3335
3335
|
"optional": false
|
|
3336
3336
|
}
|
|
3337
3337
|
],
|
|
3338
|
-
"returns": "
|
|
3338
|
+
"returns": "Midnight UTC corresponding to the local-time start of `date`.",
|
|
3339
3339
|
"tags": [
|
|
3340
3340
|
"date",
|
|
3341
3341
|
"utc",
|
|
@@ -3366,11 +3366,11 @@
|
|
|
3366
3366
|
{
|
|
3367
3367
|
"name": "inputDateString",
|
|
3368
3368
|
"type": "ISO8601DayString",
|
|
3369
|
-
"description": "-
|
|
3369
|
+
"description": "- ISO8601 day string to parse (e.g. '2022-01-15').",
|
|
3370
3370
|
"optional": false
|
|
3371
3371
|
}
|
|
3372
3372
|
],
|
|
3373
|
-
"returns": "
|
|
3373
|
+
"returns": "Midnight UTC of the calendar day named by `inputDateString`.",
|
|
3374
3374
|
"tags": [
|
|
3375
3375
|
"date",
|
|
3376
3376
|
"iso8601",
|
|
@@ -3400,11 +3400,11 @@
|
|
|
3400
3400
|
{
|
|
3401
3401
|
"name": "input",
|
|
3402
3402
|
"type": "string",
|
|
3403
|
-
"description": "-
|
|
3403
|
+
"description": "- Value to test against the ISO8601 day-string pattern.",
|
|
3404
3404
|
"optional": false
|
|
3405
3405
|
}
|
|
3406
3406
|
],
|
|
3407
|
-
"returns": "True
|
|
3407
|
+
"returns": "True when the input is exactly a YYYY-MM-DD value.",
|
|
3408
3408
|
"tags": [
|
|
3409
3409
|
"date",
|
|
3410
3410
|
"iso8601",
|
|
@@ -3434,11 +3434,11 @@
|
|
|
3434
3434
|
{
|
|
3435
3435
|
"name": "input",
|
|
3436
3436
|
"type": "string",
|
|
3437
|
-
"description": "-
|
|
3437
|
+
"description": "- Value to test for an ISO8601 day-string prefix.",
|
|
3438
3438
|
"optional": false
|
|
3439
3439
|
}
|
|
3440
3440
|
],
|
|
3441
|
-
"returns": "True
|
|
3441
|
+
"returns": "True when the input begins with a YYYY-MM-DD prefix.",
|
|
3442
3442
|
"tags": [
|
|
3443
3443
|
"date",
|
|
3444
3444
|
"iso8601",
|
|
@@ -3493,11 +3493,11 @@
|
|
|
3493
3493
|
{
|
|
3494
3494
|
"name": "input",
|
|
3495
3495
|
"type": "string",
|
|
3496
|
-
"description": "-
|
|
3496
|
+
"description": "- Value to test against the slash-separated date pattern.",
|
|
3497
3497
|
"optional": false
|
|
3498
3498
|
}
|
|
3499
3499
|
],
|
|
3500
|
-
"returns": "True
|
|
3500
|
+
"returns": "True when the input matches the Month/Day/Year slash format.",
|
|
3501
3501
|
"tags": [
|
|
3502
3502
|
"date",
|
|
3503
3503
|
"slash",
|
|
@@ -3595,11 +3595,11 @@
|
|
|
3595
3595
|
{
|
|
3596
3596
|
"name": "dateTimeNumber",
|
|
3597
3597
|
"type": "Maybe<UnixDateTimeMillisecondsNumber>",
|
|
3598
|
-
"description": "- Unix timestamp number to convert",
|
|
3598
|
+
"description": "- Unix timestamp number to convert.",
|
|
3599
3599
|
"optional": false
|
|
3600
3600
|
}
|
|
3601
3601
|
],
|
|
3602
|
-
"returns": "Date object if timestamp is valid, null/undefined if timestamp is null/undefined",
|
|
3602
|
+
"returns": "Date object if timestamp is valid, null/undefined if timestamp is null/undefined.",
|
|
3603
3603
|
"tags": [
|
|
3604
3604
|
"date",
|
|
3605
3605
|
"milliseconds",
|
|
@@ -3628,17 +3628,17 @@
|
|
|
3628
3628
|
{
|
|
3629
3629
|
"name": "dateOrMilliseconds",
|
|
3630
3630
|
"type": "DateOrMilliseconds",
|
|
3631
|
-
"description": "-
|
|
3631
|
+
"description": "- Either a concrete Date or a millisecond offset from `now`.",
|
|
3632
3632
|
"optional": false
|
|
3633
3633
|
},
|
|
3634
3634
|
{
|
|
3635
3635
|
"name": "now",
|
|
3636
3636
|
"type": "Maybe<Date>",
|
|
3637
|
-
"description": "-
|
|
3637
|
+
"description": "- Anchor used to resolve a millisecond offset; defaults to the current time.",
|
|
3638
3638
|
"optional": true
|
|
3639
3639
|
}
|
|
3640
3640
|
],
|
|
3641
|
-
"returns": "
|
|
3641
|
+
"returns": "Resolved Date for either a direct value or the offset-from-now case.",
|
|
3642
3642
|
"tags": [
|
|
3643
3643
|
"date",
|
|
3644
3644
|
"milliseconds",
|
|
@@ -4004,11 +4004,11 @@
|
|
|
4004
4004
|
{
|
|
4005
4005
|
"name": "date",
|
|
4006
4006
|
"type": "Date",
|
|
4007
|
-
"description": "-
|
|
4007
|
+
"description": "- Reference instant whose local month should be reported.",
|
|
4008
4008
|
"optional": false
|
|
4009
4009
|
}
|
|
4010
4010
|
],
|
|
4011
|
-
"returns": "
|
|
4011
|
+
"returns": "One-based local month-of-year, ready for human-facing display.",
|
|
4012
4012
|
"tags": [
|
|
4013
4013
|
"date",
|
|
4014
4014
|
"month",
|
|
@@ -4038,11 +4038,11 @@
|
|
|
4038
4038
|
{
|
|
4039
4039
|
"name": "date",
|
|
4040
4040
|
"type": "Date",
|
|
4041
|
-
"description": "-
|
|
4041
|
+
"description": "- Reference instant whose UTC month should be reported.",
|
|
4042
4042
|
"optional": false
|
|
4043
4043
|
}
|
|
4044
4044
|
],
|
|
4045
|
-
"returns": "
|
|
4045
|
+
"returns": "One-based UTC month-of-year, ready for human-facing display.",
|
|
4046
4046
|
"tags": [
|
|
4047
4047
|
"date",
|
|
4048
4048
|
"month",
|
|
@@ -4075,7 +4075,7 @@
|
|
|
4075
4075
|
"optional": false
|
|
4076
4076
|
}
|
|
4077
4077
|
],
|
|
4078
|
-
"returns": "The month of year as a number from 1-12",
|
|
4078
|
+
"returns": "The month of year as a number from 1-12.",
|
|
4079
4079
|
"tags": [
|
|
4080
4080
|
"date",
|
|
4081
4081
|
"month",
|
|
@@ -4138,11 +4138,11 @@
|
|
|
4138
4138
|
{
|
|
4139
4139
|
"name": "value",
|
|
4140
4140
|
"type": "unknown",
|
|
4141
|
-
"description": "- The value to check",
|
|
4141
|
+
"description": "- The value to check.",
|
|
4142
4142
|
"optional": false
|
|
4143
4143
|
}
|
|
4144
4144
|
],
|
|
4145
|
-
"returns": "True if the value is a Date object",
|
|
4145
|
+
"returns": "True if the value is a Date object.",
|
|
4146
4146
|
"tags": [
|
|
4147
4147
|
"date",
|
|
4148
4148
|
"predicate",
|
|
@@ -4169,17 +4169,17 @@
|
|
|
4169
4169
|
{
|
|
4170
4170
|
"name": "a",
|
|
4171
4171
|
"type": "Date",
|
|
4172
|
-
"description": "- First date to compare",
|
|
4172
|
+
"description": "- First date to compare.",
|
|
4173
4173
|
"optional": false
|
|
4174
4174
|
},
|
|
4175
4175
|
{
|
|
4176
4176
|
"name": "b",
|
|
4177
4177
|
"type": "Date",
|
|
4178
|
-
"description": "- Second date to compare",
|
|
4178
|
+
"description": "- Second date to compare.",
|
|
4179
4179
|
"optional": false
|
|
4180
4180
|
}
|
|
4181
4181
|
],
|
|
4182
|
-
"returns": "True if the dates represent the same point in time",
|
|
4182
|
+
"returns": "True if the dates represent the same point in time.",
|
|
4183
4183
|
"tags": [
|
|
4184
4184
|
"date",
|
|
4185
4185
|
"equal",
|
|
@@ -4206,11 +4206,11 @@
|
|
|
4206
4206
|
{
|
|
4207
4207
|
"name": "input",
|
|
4208
4208
|
"type": "Date",
|
|
4209
|
-
"description": "-
|
|
4209
|
+
"description": "- Instant to compare against the system clock.",
|
|
4210
4210
|
"optional": false
|
|
4211
4211
|
}
|
|
4212
4212
|
],
|
|
4213
|
-
"returns": "True
|
|
4213
|
+
"returns": "True when `input` is strictly before the current time.",
|
|
4214
4214
|
"tags": [
|
|
4215
4215
|
"date",
|
|
4216
4216
|
"past",
|
|
@@ -4275,11 +4275,11 @@
|
|
|
4275
4275
|
{
|
|
4276
4276
|
"name": "input",
|
|
4277
4277
|
"type": "Maybe<DateOrUnixDateTimeSecondsNumber>",
|
|
4278
|
-
"description": "- Date object or unix timestamp number to convert",
|
|
4278
|
+
"description": "- Date object or unix timestamp number to convert.",
|
|
4279
4279
|
"optional": false
|
|
4280
4280
|
}
|
|
4281
4281
|
],
|
|
4282
|
-
"returns": "Unix timestamp number if input is valid, null/undefined if input is null/undefined",
|
|
4282
|
+
"returns": "Unix timestamp number if input is valid, null/undefined if input is null/undefined.",
|
|
4283
4283
|
"tags": [
|
|
4284
4284
|
"date",
|
|
4285
4285
|
"unix",
|
|
@@ -4308,7 +4308,7 @@
|
|
|
4308
4308
|
"signature": "unixDateTimeSecondsNumberForNow(): UnixDateTimeSecondsNumber",
|
|
4309
4309
|
"description": "Gets the current time as a unix timestamp number.",
|
|
4310
4310
|
"params": [],
|
|
4311
|
-
"returns": "Current time as unix timestamp number",
|
|
4311
|
+
"returns": "Current time as unix timestamp number.",
|
|
4312
4312
|
"tags": [
|
|
4313
4313
|
"date",
|
|
4314
4314
|
"unix",
|
|
@@ -4373,11 +4373,11 @@
|
|
|
4373
4373
|
{
|
|
4374
4374
|
"name": "dateTimeNumber",
|
|
4375
4375
|
"type": "Maybe<UnixDateTimeSecondsNumber>",
|
|
4376
|
-
"description": "- Unix timestamp number to convert",
|
|
4376
|
+
"description": "- Unix timestamp number to convert.",
|
|
4377
4377
|
"optional": false
|
|
4378
4378
|
}
|
|
4379
4379
|
],
|
|
4380
|
-
"returns": "Date object if timestamp is valid, null/undefined if timestamp is null/undefined",
|
|
4380
|
+
"returns": "Date object if timestamp is valid, null/undefined if timestamp is null/undefined.",
|
|
4381
4381
|
"tags": [
|
|
4382
4382
|
"date",
|
|
4383
4383
|
"unix",
|
|
@@ -4408,11 +4408,11 @@
|
|
|
4408
4408
|
{
|
|
4409
4409
|
"name": "input",
|
|
4410
4410
|
"type": "ExpirationDetailsInput<T>",
|
|
4411
|
-
"description": "- Configuration for calculating expiration",
|
|
4411
|
+
"description": "- Configuration for calculating expiration.",
|
|
4412
4412
|
"optional": false
|
|
4413
4413
|
}
|
|
4414
4414
|
],
|
|
4415
|
-
"returns": "An ExpirationDetails object that can determine expiration state",
|
|
4415
|
+
"returns": "An ExpirationDetails object that can determine expiration state.",
|
|
4416
4416
|
"tags": [
|
|
4417
4417
|
"expiration",
|
|
4418
4418
|
"expires",
|
|
@@ -4447,11 +4447,11 @@
|
|
|
4447
4447
|
{
|
|
4448
4448
|
"name": "input",
|
|
4449
4449
|
"type": "ExpirationDetailsInput<Expires>",
|
|
4450
|
-
"description": "- Input configuration used to calculate the expiration date",
|
|
4450
|
+
"description": "- Input configuration used to calculate the expiration date.",
|
|
4451
4451
|
"optional": false
|
|
4452
4452
|
}
|
|
4453
4453
|
],
|
|
4454
|
-
"returns": "The calculated expiration date, or null if no expiration is defined",
|
|
4454
|
+
"returns": "The calculated expiration date, or null if no expiration is defined.",
|
|
4455
4455
|
"tags": [
|
|
4456
4456
|
"expiration",
|
|
4457
4457
|
"expires",
|
|
@@ -4522,19 +4522,19 @@
|
|
|
4522
4522
|
{
|
|
4523
4523
|
"name": "threshold",
|
|
4524
4524
|
"type": "Milliseconds",
|
|
4525
|
-
"description": "The threshold time. Typically this is amount of time that was used to calculate the original \"nextRunAt\" time.",
|
|
4525
|
+
"description": "- The threshold time. Typically this is amount of time that was used to calculate the original \"nextRunAt\" time.",
|
|
4526
4526
|
"optional": false
|
|
4527
4527
|
},
|
|
4528
4528
|
{
|
|
4529
4529
|
"name": "nextRunAt",
|
|
4530
4530
|
"type": "Maybe<DateOrUnixDateTimeMillisecondsNumber>",
|
|
4531
|
-
"description": "Time the next run will occur. If null/undefined, then this function will return false.",
|
|
4531
|
+
"description": "- Time the next run will occur. If null/undefined, then this function will return false.",
|
|
4532
4532
|
"optional": false
|
|
4533
4533
|
},
|
|
4534
4534
|
{
|
|
4535
4535
|
"name": "now",
|
|
4536
4536
|
"type": "Maybe<Date>",
|
|
4537
|
-
"description": "Optional override for the current time. Defaults to the current time.",
|
|
4537
|
+
"description": "- Optional override for the current time. Defaults to the current time.",
|
|
4538
4538
|
"optional": true
|
|
4539
4539
|
}
|
|
4540
4540
|
],
|
|
@@ -4568,13 +4568,13 @@
|
|
|
4568
4568
|
{
|
|
4569
4569
|
"name": "throttleTime",
|
|
4570
4570
|
"type": "Maybe<Milliseconds>",
|
|
4571
|
-
"description": "- Minimum time in milliseconds that must pass between operations",
|
|
4571
|
+
"description": "- Minimum time in milliseconds that must pass between operations.",
|
|
4572
4572
|
"optional": false
|
|
4573
4573
|
},
|
|
4574
4574
|
{
|
|
4575
4575
|
"name": "lastRunAt",
|
|
4576
4576
|
"type": "Maybe<DateOrUnixDateTimeMillisecondsNumber>",
|
|
4577
|
-
"description": "- Timestamp when the operation was last performed",
|
|
4577
|
+
"description": "- Timestamp when the operation was last performed.",
|
|
4578
4578
|
"optional": false
|
|
4579
4579
|
},
|
|
4580
4580
|
{
|
|
@@ -4584,7 +4584,7 @@
|
|
|
4584
4584
|
"optional": true
|
|
4585
4585
|
}
|
|
4586
4586
|
],
|
|
4587
|
-
"returns": "True if the operation should be throttled (not enough time has passed), false otherwise",
|
|
4587
|
+
"returns": "True if the operation should be throttled (not enough time has passed), false otherwise.",
|
|
4588
4588
|
"tags": [
|
|
4589
4589
|
"throttle",
|
|
4590
4590
|
"throttled",
|
|
@@ -4615,11 +4615,11 @@
|
|
|
4615
4615
|
{
|
|
4616
4616
|
"name": "details",
|
|
4617
4617
|
"type": "ExpirationDetails<Expires>[]",
|
|
4618
|
-
"description": "- Collection of ExpirationDetails to check",
|
|
4618
|
+
"description": "- Collection of ExpirationDetails to check.",
|
|
4619
4619
|
"optional": false
|
|
4620
4620
|
}
|
|
4621
4621
|
],
|
|
4622
|
-
"returns": "True if at least one item has not expired, false otherwise",
|
|
4622
|
+
"returns": "True if at least one item has not expired, false otherwise.",
|
|
4623
4623
|
"tags": [
|
|
4624
4624
|
"expiration",
|
|
4625
4625
|
"valid",
|
|
@@ -4651,7 +4651,7 @@
|
|
|
4651
4651
|
{
|
|
4652
4652
|
"name": "details",
|
|
4653
4653
|
"type": "ExpirationDetails<Expires>[]",
|
|
4654
|
-
"description": "- Collection of ExpirationDetails to check",
|
|
4654
|
+
"description": "- Collection of ExpirationDetails to check.",
|
|
4655
4655
|
"optional": false
|
|
4656
4656
|
},
|
|
4657
4657
|
{
|
|
@@ -4661,7 +4661,7 @@
|
|
|
4661
4661
|
"optional": true
|
|
4662
4662
|
}
|
|
4663
4663
|
],
|
|
4664
|
-
"returns": "True if any item has expired, or the defaultIfEmpty value for an empty list",
|
|
4664
|
+
"returns": "True if any item has expired, or the defaultIfEmpty value for an empty list.",
|
|
4665
4665
|
"tags": [
|
|
4666
4666
|
"expiration",
|
|
4667
4667
|
"refresh",
|
|
@@ -4728,11 +4728,11 @@
|
|
|
4728
4728
|
{
|
|
4729
4729
|
"name": "transform",
|
|
4730
4730
|
"type": "DayOfWeekNamesTransformConfig",
|
|
4731
|
-
"description": "- Optional configuration for abbreviation and casing",
|
|
4731
|
+
"description": "- Optional configuration for abbreviation and casing.",
|
|
4732
4732
|
"optional": true
|
|
4733
4733
|
}
|
|
4734
4734
|
],
|
|
4735
|
-
"returns": "
|
|
4735
|
+
"returns": "Reusable resolver that maps a weekday to its formatted name (or 'UNKNOWN').",
|
|
4736
4736
|
"tags": [
|
|
4737
4737
|
"date",
|
|
4738
4738
|
"week",
|
|
@@ -4762,11 +4762,11 @@
|
|
|
4762
4762
|
{
|
|
4763
4763
|
"name": "target",
|
|
4764
4764
|
"type": "string",
|
|
4765
|
-
"description": "-
|
|
4765
|
+
"description": "- Substring that must appear in the resolved error message.",
|
|
4766
4766
|
"optional": false
|
|
4767
4767
|
}
|
|
4768
4768
|
],
|
|
4769
|
-
"returns": "
|
|
4769
|
+
"returns": "Reusable predicate that yields true when the inspected error contains `target`.",
|
|
4770
4770
|
"tags": [
|
|
4771
4771
|
"error",
|
|
4772
4772
|
"message",
|
|
@@ -4795,11 +4795,11 @@
|
|
|
4795
4795
|
{
|
|
4796
4796
|
"name": "inputFilters",
|
|
4797
4797
|
"type": "Maybe<FilterFunction<T>>[]",
|
|
4798
|
-
"description": "- The filter functions to merge",
|
|
4798
|
+
"description": "- The filter functions to merge.",
|
|
4799
4799
|
"optional": true
|
|
4800
4800
|
}
|
|
4801
4801
|
],
|
|
4802
|
-
"returns": "A single FilterFunction that applies all filters",
|
|
4802
|
+
"returns": "A single FilterFunction that applies all filters.",
|
|
4803
4803
|
"tags": [
|
|
4804
4804
|
"filter",
|
|
4805
4805
|
"merge",
|
|
@@ -4828,7 +4828,7 @@
|
|
|
4828
4828
|
{
|
|
4829
4829
|
"name": "decisionFn",
|
|
4830
4830
|
"type": "F",
|
|
4831
|
-
"description": "- The function whose boolean return value to invert",
|
|
4831
|
+
"description": "- The function whose boolean return value to invert.",
|
|
4832
4832
|
"optional": false
|
|
4833
4833
|
},
|
|
4834
4834
|
{
|
|
@@ -4838,7 +4838,7 @@
|
|
|
4838
4838
|
"optional": true
|
|
4839
4839
|
}
|
|
4840
4840
|
],
|
|
4841
|
-
"returns": "The inverted function, or the original if invert is false",
|
|
4841
|
+
"returns": "The inverted function, or the original if invert is false.",
|
|
4842
4842
|
"tags": [
|
|
4843
4843
|
"function",
|
|
4844
4844
|
"boolean",
|
|
@@ -4866,11 +4866,11 @@
|
|
|
4866
4866
|
{
|
|
4867
4867
|
"name": "getter",
|
|
4868
4868
|
"type": "Getter<I>",
|
|
4869
|
-
"description": "- A Getter that provides the target function",
|
|
4869
|
+
"description": "- A Getter that provides the target function.",
|
|
4870
4870
|
"optional": false
|
|
4871
4871
|
}
|
|
4872
4872
|
],
|
|
4873
|
-
"returns": "A forwarding function with the same signature as the target",
|
|
4873
|
+
"returns": "A forwarding function with the same signature as the target.",
|
|
4874
4874
|
"tags": [
|
|
4875
4875
|
"function",
|
|
4876
4876
|
"forward",
|
|
@@ -4896,11 +4896,11 @@
|
|
|
4896
4896
|
{
|
|
4897
4897
|
"name": "defaultFn",
|
|
4898
4898
|
"type": "I",
|
|
4899
|
-
"description": "- The default function to use as fallback",
|
|
4899
|
+
"description": "- The default function to use as fallback.",
|
|
4900
4900
|
"optional": false
|
|
4901
4901
|
}
|
|
4902
4902
|
],
|
|
4903
|
-
"returns": "A factory that wraps optional functions with a default fallback",
|
|
4903
|
+
"returns": "A factory that wraps optional functions with a default fallback.",
|
|
4904
4904
|
"tags": [
|
|
4905
4905
|
"function",
|
|
4906
4906
|
"forward",
|
|
@@ -4958,11 +4958,11 @@
|
|
|
4958
4958
|
{
|
|
4959
4959
|
"name": "mapFn",
|
|
4960
4960
|
"type": "MapFunction<I, O>",
|
|
4961
|
-
"description": "- The mapping function to apply",
|
|
4961
|
+
"description": "- The mapping function to apply.",
|
|
4962
4962
|
"optional": false
|
|
4963
4963
|
}
|
|
4964
4964
|
],
|
|
4965
|
-
"returns": "A factory that transforms Getters of type I to Getters of type O",
|
|
4965
|
+
"returns": "A factory that transforms Getters of type I to Getters of type O.",
|
|
4966
4966
|
"tags": [
|
|
4967
4967
|
"getter",
|
|
4968
4968
|
"map",
|
|
@@ -4987,11 +4987,11 @@
|
|
|
4987
4987
|
{
|
|
4988
4988
|
"name": "value",
|
|
4989
4989
|
"type": "unknown",
|
|
4990
|
-
"description": "- The value to check",
|
|
4990
|
+
"description": "- The value to check.",
|
|
4991
4991
|
"optional": false
|
|
4992
4992
|
}
|
|
4993
4993
|
],
|
|
4994
|
-
"returns": "True if the value is a non-class function",
|
|
4994
|
+
"returns": "True if the value is a non-class function.",
|
|
4995
4995
|
"tags": [
|
|
4996
4996
|
"getter",
|
|
4997
4997
|
"type-guard",
|
|
@@ -5064,11 +5064,11 @@
|
|
|
5064
5064
|
{
|
|
5065
5065
|
"name": "input",
|
|
5066
5066
|
"type": "GetterOrValue<T>",
|
|
5067
|
-
"description": "- A value or getter function",
|
|
5067
|
+
"description": "- A value or getter function.",
|
|
5068
5068
|
"optional": false
|
|
5069
5069
|
}
|
|
5070
5070
|
],
|
|
5071
|
-
"returns": "A Getter function that returns the value",
|
|
5071
|
+
"returns": "A Getter function that returns the value.",
|
|
5072
5072
|
"tags": [
|
|
5073
5073
|
"getter",
|
|
5074
5074
|
"factory",
|
|
@@ -5096,17 +5096,17 @@
|
|
|
5096
5096
|
{
|
|
5097
5097
|
"name": "value",
|
|
5098
5098
|
"type": "T",
|
|
5099
|
-
"description": "-
|
|
5099
|
+
"description": "- Source whose contents the factory should reproduce.",
|
|
5100
5100
|
"optional": false
|
|
5101
5101
|
},
|
|
5102
5102
|
{
|
|
5103
5103
|
"name": "copyFunction",
|
|
5104
5104
|
"type": "CopyObjectFunction<T>",
|
|
5105
|
-
"description": "-
|
|
5105
|
+
"description": "- Override for the per-call copy behavior; defaults to `copyObject`.",
|
|
5106
5106
|
"optional": true
|
|
5107
5107
|
}
|
|
5108
5108
|
],
|
|
5109
|
-
"returns": "
|
|
5109
|
+
"returns": "Stable producer that yields a fresh copy of `value` per invocation.",
|
|
5110
5110
|
"tags": [
|
|
5111
5111
|
"getter",
|
|
5112
5112
|
"factory",
|
|
@@ -5133,17 +5133,17 @@
|
|
|
5133
5133
|
{
|
|
5134
5134
|
"name": "input",
|
|
5135
5135
|
"type": "T | ObjectCopyFactory<T>",
|
|
5136
|
-
"description": "- An object value or a getter function",
|
|
5136
|
+
"description": "- An object value or a getter function.",
|
|
5137
5137
|
"optional": false
|
|
5138
5138
|
},
|
|
5139
5139
|
{
|
|
5140
5140
|
"name": "copyFunction",
|
|
5141
5141
|
"type": "CopyObjectFunction<T>",
|
|
5142
|
-
"description": "- Optional custom copy function",
|
|
5142
|
+
"description": "- Optional custom copy function.",
|
|
5143
5143
|
"optional": true
|
|
5144
5144
|
}
|
|
5145
5145
|
],
|
|
5146
|
-
"returns": "An ObjectCopyFactory for the input",
|
|
5146
|
+
"returns": "An ObjectCopyFactory for the input.",
|
|
5147
5147
|
"tags": [
|
|
5148
5148
|
"getter",
|
|
5149
5149
|
"factory",
|
|
@@ -5172,11 +5172,11 @@
|
|
|
5172
5172
|
{
|
|
5173
5173
|
"name": "input",
|
|
5174
5174
|
"type": "T",
|
|
5175
|
-
"description": "- The value to wrap",
|
|
5175
|
+
"description": "- The value to wrap.",
|
|
5176
5176
|
"optional": false
|
|
5177
5177
|
}
|
|
5178
5178
|
],
|
|
5179
|
-
"returns": "A Getter that returns the input value",
|
|
5179
|
+
"returns": "A Getter that returns the input value.",
|
|
5180
5180
|
"tags": [
|
|
5181
5181
|
"getter",
|
|
5182
5182
|
"factory",
|
|
@@ -5203,17 +5203,17 @@
|
|
|
5203
5203
|
{
|
|
5204
5204
|
"name": "factory",
|
|
5205
5205
|
"type": "Factory<T> | FactoryWithIndex<T>",
|
|
5206
|
-
"description": "-
|
|
5206
|
+
"description": "- Per-item producer invoked with the running index.",
|
|
5207
5207
|
"optional": false
|
|
5208
5208
|
},
|
|
5209
5209
|
{
|
|
5210
5210
|
"name": "count",
|
|
5211
5211
|
"type": "number",
|
|
5212
|
-
"description": "-
|
|
5212
|
+
"description": "- Total number of items to materialize.",
|
|
5213
5213
|
"optional": false
|
|
5214
5214
|
}
|
|
5215
5215
|
],
|
|
5216
|
-
"returns": "
|
|
5216
|
+
"returns": "Materialized output collected from each `factory` call.",
|
|
5217
5217
|
"tags": [
|
|
5218
5218
|
"getter",
|
|
5219
5219
|
"factory",
|
|
@@ -5281,11 +5281,11 @@
|
|
|
5281
5281
|
{
|
|
5282
5282
|
"name": "factory",
|
|
5283
5283
|
"type": "Factory<T>",
|
|
5284
|
-
"description": "- The factory to wrap",
|
|
5284
|
+
"description": "- The factory to wrap.",
|
|
5285
5285
|
"optional": false
|
|
5286
5286
|
}
|
|
5287
5287
|
],
|
|
5288
|
-
"returns": "A new factory that calls the original with no arguments",
|
|
5288
|
+
"returns": "A new factory that calls the original with no arguments.",
|
|
5289
5289
|
"tags": [
|
|
5290
5290
|
"getter",
|
|
5291
5291
|
"factory",
|
|
@@ -5313,11 +5313,11 @@
|
|
|
5313
5313
|
{
|
|
5314
5314
|
"name": "values",
|
|
5315
5315
|
"type": "T[]",
|
|
5316
|
-
"description": "-
|
|
5316
|
+
"description": "- Candidate pool the factory picks from on each call.",
|
|
5317
5317
|
"optional": false
|
|
5318
5318
|
}
|
|
5319
5319
|
],
|
|
5320
|
-
"returns": "
|
|
5320
|
+
"returns": "Stable producer that yields a uniformly random pick from `values`.",
|
|
5321
5321
|
"tags": [
|
|
5322
5322
|
"getter",
|
|
5323
5323
|
"factory",
|
|
@@ -5345,7 +5345,7 @@
|
|
|
5345
5345
|
{
|
|
5346
5346
|
"name": "values",
|
|
5347
5347
|
"type": "IterableOrValue<T>",
|
|
5348
|
-
"description": "- The value or iterable to convert",
|
|
5348
|
+
"description": "- The value or iterable to convert.",
|
|
5349
5349
|
"optional": false
|
|
5350
5350
|
},
|
|
5351
5351
|
{
|
|
@@ -5384,7 +5384,7 @@
|
|
|
5384
5384
|
{
|
|
5385
5385
|
"name": "values",
|
|
5386
5386
|
"type": "IterableOrValue<T>",
|
|
5387
|
-
"description": "- The value or iterable to convert",
|
|
5387
|
+
"description": "- The value or iterable to convert.",
|
|
5388
5388
|
"optional": false
|
|
5389
5389
|
},
|
|
5390
5390
|
{
|
|
@@ -5394,7 +5394,7 @@
|
|
|
5394
5394
|
"optional": true
|
|
5395
5395
|
}
|
|
5396
5396
|
],
|
|
5397
|
-
"returns": "
|
|
5397
|
+
"returns": "Deduped membership view collected from `values`.",
|
|
5398
5398
|
"tags": [
|
|
5399
5399
|
"iterable",
|
|
5400
5400
|
"set",
|
|
@@ -5423,7 +5423,7 @@
|
|
|
5423
5423
|
{
|
|
5424
5424
|
"name": "values",
|
|
5425
5425
|
"type": "unknown",
|
|
5426
|
-
"description": "- The value to check",
|
|
5426
|
+
"description": "- The value to check.",
|
|
5427
5427
|
"optional": false
|
|
5428
5428
|
},
|
|
5429
5429
|
{
|
|
@@ -5433,7 +5433,7 @@
|
|
|
5433
5433
|
"optional": true
|
|
5434
5434
|
}
|
|
5435
5435
|
],
|
|
5436
|
-
"returns": "True if the value is iterable",
|
|
5436
|
+
"returns": "True if the value is iterable.",
|
|
5437
5437
|
"tags": [
|
|
5438
5438
|
"iterable",
|
|
5439
5439
|
"type-guard",
|
|
@@ -5460,11 +5460,11 @@
|
|
|
5460
5460
|
{
|
|
5461
5461
|
"name": "values",
|
|
5462
5462
|
"type": "Iterable<T>",
|
|
5463
|
-
"description": "- The iterable to check",
|
|
5463
|
+
"description": "- The iterable to check.",
|
|
5464
5464
|
"optional": false
|
|
5465
5465
|
}
|
|
5466
5466
|
],
|
|
5467
|
-
"returns": "True if the iterable is empty",
|
|
5467
|
+
"returns": "True if the iterable is empty.",
|
|
5468
5468
|
"tags": [
|
|
5469
5469
|
"iterable",
|
|
5470
5470
|
"empty",
|
|
@@ -5491,11 +5491,11 @@
|
|
|
5491
5491
|
{
|
|
5492
5492
|
"name": "read",
|
|
5493
5493
|
"type": "ReadKeyFunction<T, K>",
|
|
5494
|
-
"description": "- Function that extracts a key from each value",
|
|
5494
|
+
"description": "- Function that extracts a key from each value.",
|
|
5495
5495
|
"optional": false
|
|
5496
5496
|
}
|
|
5497
5497
|
],
|
|
5498
|
-
"returns": "A factory that creates Maps from arrays of values",
|
|
5498
|
+
"returns": "A factory that creates Maps from arrays of values.",
|
|
5499
5499
|
"tags": [
|
|
5500
5500
|
"map",
|
|
5501
5501
|
"key",
|
|
@@ -5523,11 +5523,11 @@
|
|
|
5523
5523
|
{
|
|
5524
5524
|
"name": "read",
|
|
5525
5525
|
"type": "ReadMultipleKeysFunction<T, K>",
|
|
5526
|
-
"description": "- Function that extracts multiple keys from each value",
|
|
5526
|
+
"description": "- Function that extracts multiple keys from each value.",
|
|
5527
5527
|
"optional": false
|
|
5528
5528
|
}
|
|
5529
5529
|
],
|
|
5530
|
-
"returns": "A factory that creates Maps from arrays of values",
|
|
5530
|
+
"returns": "A factory that creates Maps from arrays of values.",
|
|
5531
5531
|
"tags": [
|
|
5532
5532
|
"map",
|
|
5533
5533
|
"key",
|
|
@@ -5556,11 +5556,11 @@
|
|
|
5556
5556
|
{
|
|
5557
5557
|
"name": "config",
|
|
5558
5558
|
"type": "IdBatchFactoryConfig<T, K>",
|
|
5559
|
-
"description": "- Configuration with the base factory for generating candidates and the verifier for validating them",
|
|
5559
|
+
"description": "- Configuration with the base factory for generating candidates and the verifier for validating them.",
|
|
5560
5560
|
"optional": false
|
|
5561
5561
|
}
|
|
5562
5562
|
],
|
|
5563
|
-
"returns": "An async factory function that produces the requested number of valid identifiers",
|
|
5563
|
+
"returns": "An async factory function that produces the requested number of valid identifiers.",
|
|
5564
5564
|
"tags": [
|
|
5565
5565
|
"model",
|
|
5566
5566
|
"id",
|
|
@@ -5588,11 +5588,11 @@
|
|
|
5588
5588
|
{
|
|
5589
5589
|
"name": "config",
|
|
5590
5590
|
"type": "SequentialIncrementingNumberStringModelIdFactoryConfig",
|
|
5591
|
-
"description": "- Configuration for the starting index, increment step, dencoder, and transform",
|
|
5591
|
+
"description": "- Configuration for the starting index, increment step, dencoder, and transform.",
|
|
5592
5592
|
"optional": true
|
|
5593
5593
|
}
|
|
5594
5594
|
],
|
|
5595
|
-
"returns": "A factory function that returns the next encoded string identifier on each call",
|
|
5595
|
+
"returns": "A factory function that returns the next encoded string identifier on each call.",
|
|
5596
5596
|
"tags": [
|
|
5597
5597
|
"model",
|
|
5598
5598
|
"id",
|
|
@@ -5623,11 +5623,11 @@
|
|
|
5623
5623
|
{
|
|
5624
5624
|
"name": "fields",
|
|
5625
5625
|
"type": "ModelFieldConversions<V, D>",
|
|
5626
|
-
"description": "- Field conversion definitions for each key in the model",
|
|
5626
|
+
"description": "- Field conversion definitions for each key in the model.",
|
|
5627
5627
|
"optional": false
|
|
5628
5628
|
}
|
|
5629
5629
|
],
|
|
5630
|
-
"returns": "Object with `from` and `to` mapping functions",
|
|
5630
|
+
"returns": "Object with `from` and `to` mapping functions.",
|
|
5631
5631
|
"tags": [
|
|
5632
5632
|
"model",
|
|
5633
5633
|
"conversion",
|
|
@@ -5658,11 +5658,11 @@
|
|
|
5658
5658
|
{
|
|
5659
5659
|
"name": "fields",
|
|
5660
5660
|
"type": "ModelConversionFieldValuesConfig<I>",
|
|
5661
|
-
"description": "- Array of `[key, convertFn]` tuples defining how each field is converted",
|
|
5661
|
+
"description": "- Array of `[key, convertFn]` tuples defining how each field is converted.",
|
|
5662
5662
|
"optional": false
|
|
5663
5663
|
}
|
|
5664
5664
|
],
|
|
5665
|
-
"returns": "
|
|
5665
|
+
"returns": "Reusable converter that applies the per-field transforms to any input record.",
|
|
5666
5666
|
"tags": [
|
|
5667
5667
|
"model",
|
|
5668
5668
|
"conversion",
|
|
@@ -5694,11 +5694,11 @@
|
|
|
5694
5694
|
{
|
|
5695
5695
|
"name": "config",
|
|
5696
5696
|
"type": "ModelFieldMapFunctionsConfig<I, O>",
|
|
5697
|
-
"description": "- Configuration with `from` and `to` field map configs",
|
|
5697
|
+
"description": "- Configuration with `from` and `to` field map configs.",
|
|
5698
5698
|
"optional": false
|
|
5699
5699
|
}
|
|
5700
5700
|
],
|
|
5701
|
-
"returns": "Compiled field map functions",
|
|
5701
|
+
"returns": "Compiled field map functions.",
|
|
5702
5702
|
"tags": [
|
|
5703
5703
|
"model",
|
|
5704
5704
|
"field",
|
|
@@ -5727,11 +5727,11 @@
|
|
|
5727
5727
|
{
|
|
5728
5728
|
"name": "config",
|
|
5729
5729
|
"type": "ModelFieldMapConfig<I, O>",
|
|
5730
|
-
"description": "- Configuration specifying how to convert values and handle null/undefined",
|
|
5730
|
+
"description": "- Configuration specifying how to convert values and handle null/undefined.",
|
|
5731
5731
|
"optional": false
|
|
5732
5732
|
}
|
|
5733
5733
|
],
|
|
5734
|
-
"returns": "
|
|
5734
|
+
"returns": "Reusable mapper that handles concrete and nullish inputs via the configured fallbacks.",
|
|
5735
5735
|
"tags": [
|
|
5736
5736
|
"model",
|
|
5737
5737
|
"field",
|
|
@@ -5761,11 +5761,11 @@
|
|
|
5761
5761
|
{
|
|
5762
5762
|
"name": "input",
|
|
5763
5763
|
"type": "ToModelMapFunctionsInput<T, O>",
|
|
5764
|
-
"description": "- Input that can be resolved to model map functions",
|
|
5764
|
+
"description": "- Input that can be resolved to model map functions.",
|
|
5765
5765
|
"optional": false
|
|
5766
5766
|
}
|
|
5767
5767
|
],
|
|
5768
|
-
"returns": "Bidirectional model map functions",
|
|
5768
|
+
"returns": "Bidirectional model map functions.",
|
|
5769
5769
|
"tags": [
|
|
5770
5770
|
"model",
|
|
5771
5771
|
"conversion",
|
|
@@ -5795,17 +5795,17 @@
|
|
|
5795
5795
|
{
|
|
5796
5796
|
"name": "key",
|
|
5797
5797
|
"type": "keyof T",
|
|
5798
|
-
"description": "- The property key to copy",
|
|
5798
|
+
"description": "- The property key to copy.",
|
|
5799
5799
|
"optional": false
|
|
5800
5800
|
},
|
|
5801
5801
|
{
|
|
5802
5802
|
"name": "inputConfig",
|
|
5803
5803
|
"type": "Maybe<CopyModelFieldConfig>",
|
|
5804
|
-
"description": "- Optional config with a default value for the field",
|
|
5804
|
+
"description": "- Optional config with a default value for the field.",
|
|
5805
5805
|
"optional": true
|
|
5806
5806
|
}
|
|
5807
5807
|
],
|
|
5808
|
-
"returns": "
|
|
5808
|
+
"returns": "Reusable mapper that copies the configured field (or fills in the default) per pair.",
|
|
5809
5809
|
"tags": [
|
|
5810
5810
|
"model",
|
|
5811
5811
|
"copy",
|
|
@@ -5834,11 +5834,11 @@
|
|
|
5834
5834
|
{
|
|
5835
5835
|
"name": "config",
|
|
5836
5836
|
"type": "ModifyModelMapFunctionsConfig<V, D>",
|
|
5837
|
-
"description": "- Configuration with the base map functions, modifiers, and copy options",
|
|
5837
|
+
"description": "- Configuration with the base map functions, modifiers, and copy options.",
|
|
5838
5838
|
"optional": false
|
|
5839
5839
|
}
|
|
5840
5840
|
],
|
|
5841
|
-
"returns": "New model map functions with modifiers applied before each conversion",
|
|
5841
|
+
"returns": "New model map functions with modifiers applied before each conversion.",
|
|
5842
5842
|
"tags": [
|
|
5843
5843
|
"model",
|
|
5844
5844
|
"map",
|
|
@@ -5867,23 +5867,23 @@
|
|
|
5867
5867
|
{
|
|
5868
5868
|
"name": "mapFn",
|
|
5869
5869
|
"type": "ModelMapFunction<I, O>",
|
|
5870
|
-
"description": "- The base map function to wrap",
|
|
5870
|
+
"description": "- The base map function to wrap.",
|
|
5871
5871
|
"optional": false
|
|
5872
5872
|
},
|
|
5873
5873
|
{
|
|
5874
5874
|
"name": "modifyModel",
|
|
5875
5875
|
"type": "Maybe<ModifierFunction<I>>",
|
|
5876
|
-
"description": "- Optional modifier to apply before mapping",
|
|
5876
|
+
"description": "- Optional modifier to apply before mapping.",
|
|
5877
5877
|
"optional": false
|
|
5878
5878
|
},
|
|
5879
5879
|
{
|
|
5880
5880
|
"name": "copy",
|
|
5881
5881
|
"type": "boolean",
|
|
5882
|
-
"description": "- Whether to shallow-copy the input before modifying; defaults to true",
|
|
5882
|
+
"description": "- Whether to shallow-copy the input before modifying; defaults to true.",
|
|
5883
5883
|
"optional": true
|
|
5884
5884
|
}
|
|
5885
5885
|
],
|
|
5886
|
-
"returns": "The wrapped map function, or the original if no modifier is provided",
|
|
5886
|
+
"returns": "The wrapped map function, or the original if no modifier is provided.",
|
|
5887
5887
|
"tags": [
|
|
5888
5888
|
"model",
|
|
5889
5889
|
"map",
|
|
@@ -5950,17 +5950,17 @@
|
|
|
5950
5950
|
{
|
|
5951
5951
|
"name": "input",
|
|
5952
5952
|
"type": "T[]",
|
|
5953
|
-
"description": "- Array of models to index",
|
|
5953
|
+
"description": "- Array of models to index.",
|
|
5954
5954
|
"optional": false
|
|
5955
5955
|
},
|
|
5956
5956
|
{
|
|
5957
5957
|
"name": "read",
|
|
5958
5958
|
"type": "ReadRelationKeysFunction<T>",
|
|
5959
|
-
"description": "- Function that returns an array of relation keys for each model",
|
|
5959
|
+
"description": "- Function that returns an array of relation keys for each model.",
|
|
5960
5960
|
"optional": false
|
|
5961
5961
|
}
|
|
5962
5962
|
],
|
|
5963
|
-
"returns": "Map from relation key to model",
|
|
5963
|
+
"returns": "Map from relation key to model.",
|
|
5964
5964
|
"tags": [
|
|
5965
5965
|
"model",
|
|
5966
5966
|
"map",
|
|
@@ -5990,17 +5990,17 @@
|
|
|
5990
5990
|
{
|
|
5991
5991
|
"name": "typeReader",
|
|
5992
5992
|
"type": "ReadModelTypeFunction<T, M>",
|
|
5993
|
-
"description": "- Function to extract the model type from input data",
|
|
5993
|
+
"description": "- Function to extract the model type from input data.",
|
|
5994
5994
|
"optional": false
|
|
5995
5995
|
},
|
|
5996
5996
|
{
|
|
5997
5997
|
"name": "defaultType",
|
|
5998
5998
|
"type": "string",
|
|
5999
|
-
"description": "- Fallback type string when the reader returns nullish",
|
|
5999
|
+
"description": "- Fallback type string when the reader returns nullish.",
|
|
6000
6000
|
"optional": true
|
|
6001
6001
|
}
|
|
6002
6002
|
],
|
|
6003
|
-
"returns": "Factory function that produces ModelTypeDataPair values",
|
|
6003
|
+
"returns": "Factory function that produces ModelTypeDataPair values.",
|
|
6004
6004
|
"tags": [
|
|
6005
6005
|
"model",
|
|
6006
6006
|
"type",
|
|
@@ -6032,7 +6032,7 @@
|
|
|
6032
6032
|
"optional": false
|
|
6033
6033
|
}
|
|
6034
6034
|
],
|
|
6035
|
-
"returns": "
|
|
6035
|
+
"returns": "Reusable consumer that drains a stream and resolves with its decoded contents.",
|
|
6036
6036
|
"tags": [
|
|
6037
6037
|
"nodejs",
|
|
6038
6038
|
"stream",
|
|
@@ -6062,11 +6062,11 @@
|
|
|
6062
6062
|
{
|
|
6063
6063
|
"name": "bounds",
|
|
6064
6064
|
"type": "NumberBound",
|
|
6065
|
-
"description": "- The min/max bounds to test against",
|
|
6065
|
+
"description": "- The min/max bounds to test against.",
|
|
6066
6066
|
"optional": false
|
|
6067
6067
|
}
|
|
6068
6068
|
],
|
|
6069
|
-
"returns": "
|
|
6069
|
+
"returns": "Returns `true` if the input number is within bounds.",
|
|
6070
6070
|
"tags": [
|
|
6071
6071
|
"number",
|
|
6072
6072
|
"bound",
|
|
@@ -6099,11 +6099,11 @@
|
|
|
6099
6099
|
{
|
|
6100
6100
|
"name": "wrapNumberFunctionConfig",
|
|
6101
6101
|
"type": "WrapNumberFunctionConfig<T>",
|
|
6102
|
-
"description": "- Configuration with min, max, and optional fence post behavior",
|
|
6102
|
+
"description": "- Configuration with min, max, and optional fence post behavior.",
|
|
6103
6103
|
"optional": false
|
|
6104
6104
|
}
|
|
6105
6105
|
],
|
|
6106
|
-
"returns": "
|
|
6106
|
+
"returns": "Wraps input numbers into the bounded range.",
|
|
6107
6107
|
"tags": [
|
|
6108
6108
|
"number",
|
|
6109
6109
|
"wrap",
|
|
@@ -6134,11 +6134,11 @@
|
|
|
6134
6134
|
{
|
|
6135
6135
|
"name": "boundNumberFunctionConfig",
|
|
6136
6136
|
"type": "BoundNumberFunctionConfig<T>",
|
|
6137
|
-
"description": "- Configuration with min, max, and optional wrap behavior",
|
|
6137
|
+
"description": "- Configuration with min, max, and optional wrap behavior.",
|
|
6138
6138
|
"optional": false
|
|
6139
6139
|
}
|
|
6140
6140
|
],
|
|
6141
|
-
"returns": "
|
|
6141
|
+
"returns": "Bounds input numbers into the configured range.",
|
|
6142
6142
|
"tags": [
|
|
6143
6143
|
"number",
|
|
6144
6144
|
"bound",
|
|
@@ -6169,23 +6169,23 @@
|
|
|
6169
6169
|
{
|
|
6170
6170
|
"name": "input",
|
|
6171
6171
|
"type": "number",
|
|
6172
|
-
"description": "- Number to clamp",
|
|
6172
|
+
"description": "- Number to clamp.",
|
|
6173
6173
|
"optional": false
|
|
6174
6174
|
},
|
|
6175
6175
|
{
|
|
6176
6176
|
"name": "min",
|
|
6177
6177
|
"type": "T",
|
|
6178
|
-
"description": "- Minimum allowed value",
|
|
6178
|
+
"description": "- Minimum allowed value.",
|
|
6179
6179
|
"optional": false
|
|
6180
6180
|
},
|
|
6181
6181
|
{
|
|
6182
6182
|
"name": "max",
|
|
6183
6183
|
"type": "T",
|
|
6184
|
-
"description": "- Maximum allowed value",
|
|
6184
|
+
"description": "- Maximum allowed value.",
|
|
6185
6185
|
"optional": false
|
|
6186
6186
|
}
|
|
6187
6187
|
],
|
|
6188
|
-
"returns": "The clamped value",
|
|
6188
|
+
"returns": "The clamped value.",
|
|
6189
6189
|
"tags": [
|
|
6190
6190
|
"number",
|
|
6191
6191
|
"clamp",
|
|
@@ -6215,11 +6215,11 @@
|
|
|
6215
6215
|
{
|
|
6216
6216
|
"name": "unit",
|
|
6217
6217
|
"type": "U",
|
|
6218
|
-
"description": "- The unit prefix to prepend; defaults to \"$\"",
|
|
6218
|
+
"description": "- The unit prefix to prepend; defaults to \"$\".",
|
|
6219
6219
|
"optional": true
|
|
6220
6220
|
}
|
|
6221
6221
|
],
|
|
6222
|
-
"returns": "
|
|
6222
|
+
"returns": "Formats dollar amounts with the configured unit.",
|
|
6223
6223
|
"tags": [
|
|
6224
6224
|
"number",
|
|
6225
6225
|
"dollar",
|
|
@@ -6254,7 +6254,7 @@
|
|
|
6254
6254
|
"optional": true
|
|
6255
6255
|
}
|
|
6256
6256
|
],
|
|
6257
|
-
"returns": "A factory function that returns the next number in the sequence on each call",
|
|
6257
|
+
"returns": "A factory function that returns the next number in the sequence on each call.",
|
|
6258
6258
|
"tags": [
|
|
6259
6259
|
"number",
|
|
6260
6260
|
"factory",
|
|
@@ -6286,7 +6286,7 @@
|
|
|
6286
6286
|
"optional": false
|
|
6287
6287
|
}
|
|
6288
6288
|
],
|
|
6289
|
-
"returns": "The decimal equivalent",
|
|
6289
|
+
"returns": "The decimal equivalent.",
|
|
6290
6290
|
"tags": [
|
|
6291
6291
|
"number",
|
|
6292
6292
|
"percent",
|
|
@@ -6317,7 +6317,7 @@
|
|
|
6317
6317
|
"optional": false
|
|
6318
6318
|
}
|
|
6319
6319
|
],
|
|
6320
|
-
"returns": "The percent number equivalent",
|
|
6320
|
+
"returns": "The percent number equivalent.",
|
|
6321
6321
|
"tags": [
|
|
6322
6322
|
"number",
|
|
6323
6323
|
"percent",
|
|
@@ -6344,11 +6344,11 @@
|
|
|
6344
6344
|
{
|
|
6345
6345
|
"name": "input",
|
|
6346
6346
|
"type": "AsNumberInput",
|
|
6347
|
-
"description": "-
|
|
6347
|
+
"description": "- Numeric value, numeric string, or null/undefined.",
|
|
6348
6348
|
"optional": false
|
|
6349
6349
|
}
|
|
6350
6350
|
],
|
|
6351
|
-
"returns": "The numeric value, or 0 for null/undefined",
|
|
6351
|
+
"returns": "The numeric value, or 0 for null/undefined.",
|
|
6352
6352
|
"tags": [
|
|
6353
6353
|
"number",
|
|
6354
6354
|
"parse",
|
|
@@ -6373,17 +6373,17 @@
|
|
|
6373
6373
|
{
|
|
6374
6374
|
"name": "value",
|
|
6375
6375
|
"type": "Maybe<number>",
|
|
6376
|
-
"description": "- The number to check",
|
|
6376
|
+
"description": "- The number to check.",
|
|
6377
6377
|
"optional": false
|
|
6378
6378
|
},
|
|
6379
6379
|
{
|
|
6380
6380
|
"name": "divisor",
|
|
6381
6381
|
"type": "number",
|
|
6382
|
-
"description": "- The divisor to test against",
|
|
6382
|
+
"description": "- The divisor to test against.",
|
|
6383
6383
|
"optional": false
|
|
6384
6384
|
}
|
|
6385
6385
|
],
|
|
6386
|
-
"returns": "`true` if the remainder is zero",
|
|
6386
|
+
"returns": "`true` if the remainder is zero.",
|
|
6387
6387
|
"tags": [
|
|
6388
6388
|
"number",
|
|
6389
6389
|
"divisible",
|
|
@@ -6414,17 +6414,17 @@
|
|
|
6414
6414
|
{
|
|
6415
6415
|
"name": "value",
|
|
6416
6416
|
"type": "number",
|
|
6417
|
-
"description": "- The value to find divisible neighbors for",
|
|
6417
|
+
"description": "- The value to find divisible neighbors for.",
|
|
6418
6418
|
"optional": false
|
|
6419
6419
|
},
|
|
6420
6420
|
{
|
|
6421
6421
|
"name": "divisor",
|
|
6422
6422
|
"type": "number",
|
|
6423
|
-
"description": "- The divisor to align to",
|
|
6423
|
+
"description": "- The divisor to align to.",
|
|
6424
6424
|
"optional": false
|
|
6425
6425
|
}
|
|
6426
6426
|
],
|
|
6427
|
-
"returns": "Object with the input value, divisor, and the nearest ceil/floor divisible values",
|
|
6427
|
+
"returns": "Object with the input value, divisor, and the nearest ceil/floor divisible values.",
|
|
6428
6428
|
"tags": [
|
|
6429
6429
|
"number",
|
|
6430
6430
|
"divisible",
|
|
@@ -6454,11 +6454,11 @@
|
|
|
6454
6454
|
{
|
|
6455
6455
|
"name": "value",
|
|
6456
6456
|
"type": "number",
|
|
6457
|
-
"description": "- Number to test",
|
|
6457
|
+
"description": "- Number to test.",
|
|
6458
6458
|
"optional": false
|
|
6459
6459
|
}
|
|
6460
6460
|
],
|
|
6461
|
-
"returns": "`true` if even",
|
|
6461
|
+
"returns": "`true` if even.",
|
|
6462
6462
|
"tags": [
|
|
6463
6463
|
"number",
|
|
6464
6464
|
"even",
|
|
@@ -6486,11 +6486,11 @@
|
|
|
6486
6486
|
{
|
|
6487
6487
|
"name": "value",
|
|
6488
6488
|
"type": "number",
|
|
6489
|
-
"description": "- Number to test",
|
|
6489
|
+
"description": "- Number to test.",
|
|
6490
6490
|
"optional": false
|
|
6491
6491
|
}
|
|
6492
6492
|
],
|
|
6493
|
-
"returns": "`true` if odd",
|
|
6493
|
+
"returns": "`true` if odd.",
|
|
6494
6494
|
"tags": [
|
|
6495
6495
|
"number",
|
|
6496
6496
|
"odd",
|
|
@@ -6528,7 +6528,7 @@
|
|
|
6528
6528
|
"optional": false
|
|
6529
6529
|
}
|
|
6530
6530
|
],
|
|
6531
|
-
"returns": "Sum of all integers in the range",
|
|
6531
|
+
"returns": "Sum of all integers in the range.",
|
|
6532
6532
|
"tags": [
|
|
6533
6533
|
"number",
|
|
6534
6534
|
"sum",
|
|
@@ -6555,11 +6555,11 @@
|
|
|
6555
6555
|
{
|
|
6556
6556
|
"name": "values",
|
|
6557
6557
|
"type": "Iterable<number>",
|
|
6558
|
-
"description": "- Iterable of numbers to examine",
|
|
6558
|
+
"description": "- Iterable of numbers to examine.",
|
|
6559
6559
|
"optional": false
|
|
6560
6560
|
}
|
|
6561
6561
|
],
|
|
6562
|
-
"returns": "Object with `min` and `max` values",
|
|
6562
|
+
"returns": "Object with `min` and `max` values.",
|
|
6563
6563
|
"tags": [
|
|
6564
6564
|
"number",
|
|
6565
6565
|
"min",
|
|
@@ -6588,17 +6588,17 @@
|
|
|
6588
6588
|
{
|
|
6589
6589
|
"name": "x",
|
|
6590
6590
|
"type": "number",
|
|
6591
|
-
"description": "- The base of the logarithm",
|
|
6591
|
+
"description": "- The base of the logarithm.",
|
|
6592
6592
|
"optional": false
|
|
6593
6593
|
},
|
|
6594
6594
|
{
|
|
6595
6595
|
"name": "y",
|
|
6596
6596
|
"type": "number",
|
|
6597
|
-
"description": "- The value to compute the logarithm of",
|
|
6597
|
+
"description": "- The value to compute the logarithm of.",
|
|
6598
6598
|
"optional": false
|
|
6599
6599
|
}
|
|
6600
6600
|
],
|
|
6601
|
-
"returns": "The base-x logarithm of y",
|
|
6601
|
+
"returns": "The base-x logarithm of y.",
|
|
6602
6602
|
"tags": [
|
|
6603
6603
|
"number",
|
|
6604
6604
|
"log",
|
|
@@ -6623,17 +6623,17 @@
|
|
|
6623
6623
|
{
|
|
6624
6624
|
"name": "maxOrArgs",
|
|
6625
6625
|
"type": "RandomNumberFactoryInput",
|
|
6626
|
-
"description": "- Maximum value (exclusive) or full configuration object",
|
|
6626
|
+
"description": "- Maximum value (exclusive) or full configuration object.",
|
|
6627
6627
|
"optional": false
|
|
6628
6628
|
},
|
|
6629
6629
|
{
|
|
6630
6630
|
"name": "roundingInput",
|
|
6631
6631
|
"type": "RoundingInput",
|
|
6632
|
-
"description": "- Optional rounding mode override",
|
|
6632
|
+
"description": "- Optional rounding mode override.",
|
|
6633
6633
|
"optional": true
|
|
6634
6634
|
}
|
|
6635
6635
|
],
|
|
6636
|
-
"returns": "A factory function that produces random numbers within the range",
|
|
6636
|
+
"returns": "A factory function that produces random numbers within the range.",
|
|
6637
6637
|
"tags": [
|
|
6638
6638
|
"number",
|
|
6639
6639
|
"random",
|
|
@@ -6662,17 +6662,17 @@
|
|
|
6662
6662
|
{
|
|
6663
6663
|
"name": "maxOrArgs",
|
|
6664
6664
|
"type": "RandomNumberFactoryInput",
|
|
6665
|
-
"description": "- Maximum value (exclusive) or full configuration object",
|
|
6665
|
+
"description": "- Maximum value (exclusive) or full configuration object.",
|
|
6666
6666
|
"optional": false
|
|
6667
6667
|
},
|
|
6668
6668
|
{
|
|
6669
6669
|
"name": "roundingInput",
|
|
6670
6670
|
"type": "RoundingInput",
|
|
6671
|
-
"description": "- Optional rounding mode",
|
|
6671
|
+
"description": "- Optional rounding mode.",
|
|
6672
6672
|
"optional": true
|
|
6673
6673
|
}
|
|
6674
6674
|
],
|
|
6675
|
-
"returns": "A single random number",
|
|
6675
|
+
"returns": "A single random number.",
|
|
6676
6676
|
"tags": [
|
|
6677
6677
|
"number",
|
|
6678
6678
|
"random",
|
|
@@ -6697,11 +6697,11 @@
|
|
|
6697
6697
|
{
|
|
6698
6698
|
"name": "type",
|
|
6699
6699
|
"type": "NumberRounding",
|
|
6700
|
-
"description": "- The rounding strategy: 'floor', 'ceil', 'round', or 'none'",
|
|
6700
|
+
"description": "- The rounding strategy: 'floor', 'ceil', 'round', or 'none'.",
|
|
6701
6701
|
"optional": false
|
|
6702
6702
|
}
|
|
6703
6703
|
],
|
|
6704
|
-
"returns": "The corresponding Math function, or an identity function for 'none'",
|
|
6704
|
+
"returns": "The corresponding Math function, or an identity function for 'none'.",
|
|
6705
6705
|
"tags": [
|
|
6706
6706
|
"number",
|
|
6707
6707
|
"round",
|
|
@@ -6731,17 +6731,17 @@
|
|
|
6731
6731
|
{
|
|
6732
6732
|
"name": "input",
|
|
6733
6733
|
"type": "AsNumberInput",
|
|
6734
|
-
"description": "- Number, number string, or null/undefined",
|
|
6734
|
+
"description": "- Number, number string, or null/undefined.",
|
|
6735
6735
|
"optional": false
|
|
6736
6736
|
},
|
|
6737
6737
|
{
|
|
6738
6738
|
"name": "precision",
|
|
6739
6739
|
"type": "NumberPrecision",
|
|
6740
|
-
"description": "- Number of decimal places to retain",
|
|
6740
|
+
"description": "- Number of decimal places to retain.",
|
|
6741
6741
|
"optional": false
|
|
6742
6742
|
}
|
|
6743
6743
|
],
|
|
6744
|
-
"returns": "The truncated number value",
|
|
6744
|
+
"returns": "The truncated number value.",
|
|
6745
6745
|
"tags": [
|
|
6746
6746
|
"number",
|
|
6747
6747
|
"precision",
|
|
@@ -6772,11 +6772,11 @@
|
|
|
6772
6772
|
{
|
|
6773
6773
|
"name": "input",
|
|
6774
6774
|
"type": "AsNumberInput",
|
|
6775
|
-
"description": "- Number, number string, or null/undefined",
|
|
6775
|
+
"description": "- Number, number string, or null/undefined.",
|
|
6776
6776
|
"optional": false
|
|
6777
6777
|
}
|
|
6778
6778
|
],
|
|
6779
|
-
"returns": "The truncated integer value",
|
|
6779
|
+
"returns": "The truncated integer value.",
|
|
6780
6780
|
"tags": [
|
|
6781
6781
|
"number",
|
|
6782
6782
|
"integer",
|
|
@@ -6806,7 +6806,7 @@
|
|
|
6806
6806
|
{
|
|
6807
6807
|
"name": "precision",
|
|
6808
6808
|
"type": "NumberPrecision",
|
|
6809
|
-
"description": "- Number of decimal places to retain",
|
|
6809
|
+
"description": "- Number of decimal places to retain.",
|
|
6810
6810
|
"optional": false
|
|
6811
6811
|
},
|
|
6812
6812
|
{
|
|
@@ -6816,7 +6816,7 @@
|
|
|
6816
6816
|
"optional": true
|
|
6817
6817
|
}
|
|
6818
6818
|
],
|
|
6819
|
-
"returns": "
|
|
6819
|
+
"returns": "Accepts a number or string and returns the truncated number.",
|
|
6820
6820
|
"tags": [
|
|
6821
6821
|
"number",
|
|
6822
6822
|
"precision",
|
|
@@ -6847,7 +6847,7 @@
|
|
|
6847
6847
|
{
|
|
6848
6848
|
"name": "precision",
|
|
6849
6849
|
"type": "NumberPrecision",
|
|
6850
|
-
"description": "- Number of decimal places",
|
|
6850
|
+
"description": "- Number of decimal places.",
|
|
6851
6851
|
"optional": false
|
|
6852
6852
|
},
|
|
6853
6853
|
{
|
|
@@ -6857,7 +6857,7 @@
|
|
|
6857
6857
|
"optional": true
|
|
6858
6858
|
}
|
|
6859
6859
|
],
|
|
6860
|
-
"returns": "
|
|
6860
|
+
"returns": "Rounds numbers to the configured precision.",
|
|
6861
6861
|
"tags": [
|
|
6862
6862
|
"number",
|
|
6863
6863
|
"round",
|
|
@@ -6887,11 +6887,11 @@
|
|
|
6887
6887
|
{
|
|
6888
6888
|
"name": "input",
|
|
6889
6889
|
"type": "RoundNumberToStepFunctionInput",
|
|
6890
|
-
"description": "- Step size or full configuration",
|
|
6890
|
+
"description": "- Step size or full configuration.",
|
|
6891
6891
|
"optional": false
|
|
6892
6892
|
}
|
|
6893
6893
|
],
|
|
6894
|
-
"returns": "
|
|
6894
|
+
"returns": "Rounds input numbers to the nearest step.",
|
|
6895
6895
|
"tags": [
|
|
6896
6896
|
"number",
|
|
6897
6897
|
"round",
|
|
@@ -6921,11 +6921,11 @@
|
|
|
6921
6921
|
{
|
|
6922
6922
|
"name": "readNumberFn",
|
|
6923
6923
|
"type": "ReadNumberFunction<T>",
|
|
6924
|
-
"description": "- Function that extracts the numeric value from each item",
|
|
6924
|
+
"description": "- Function that extracts the numeric value from each item.",
|
|
6925
6925
|
"optional": false
|
|
6926
6926
|
}
|
|
6927
6927
|
],
|
|
6928
|
-
"returns": "A sort comparator function for ascending numeric order",
|
|
6928
|
+
"returns": "A sort comparator function for ascending numeric order.",
|
|
6929
6929
|
"tags": [
|
|
6930
6930
|
"number",
|
|
6931
6931
|
"sort",
|
|
@@ -6954,11 +6954,11 @@
|
|
|
6954
6954
|
{
|
|
6955
6955
|
"name": "config",
|
|
6956
6956
|
"type": "TransformNumberFunctionConfig<N>",
|
|
6957
|
-
"description": "- Configuration with optional transform, roundToStep, precision, and bounds",
|
|
6957
|
+
"description": "- Configuration with optional transform, roundToStep, precision, and bounds.",
|
|
6958
6958
|
"optional": false
|
|
6959
6959
|
}
|
|
6960
6960
|
],
|
|
6961
|
-
"returns": "A single function that applies all configured transformations in sequence",
|
|
6961
|
+
"returns": "A single function that applies all configured transformations in sequence.",
|
|
6962
6962
|
"tags": [
|
|
6963
6963
|
"number",
|
|
6964
6964
|
"transform",
|
|
@@ -6988,11 +6988,11 @@
|
|
|
6988
6988
|
{
|
|
6989
6989
|
"name": "config",
|
|
6990
6990
|
"type": "ObjectDeltaArrayCompressorConfig<T>",
|
|
6991
|
-
"description": "- Configuration with the equality checker that defines which fields to track",
|
|
6991
|
+
"description": "- Configuration with the equality checker that defines which fields to track.",
|
|
6992
6992
|
"optional": false
|
|
6993
6993
|
}
|
|
6994
6994
|
],
|
|
6995
|
-
"returns": "A compressor with `compress` and `expand` methods",
|
|
6995
|
+
"returns": "A compressor with `compress` and `expand` methods.",
|
|
6996
6996
|
"tags": [
|
|
6997
6997
|
"object",
|
|
6998
6998
|
"delta",
|
|
@@ -7021,11 +7021,11 @@
|
|
|
7021
7021
|
{
|
|
7022
7022
|
"name": "obj",
|
|
7023
7023
|
"type": "Maybe<T>",
|
|
7024
|
-
"description": "- Object to check",
|
|
7024
|
+
"description": "- Object to check.",
|
|
7025
7025
|
"optional": false
|
|
7026
7026
|
}
|
|
7027
7027
|
],
|
|
7028
|
-
"returns": "`true` if the object is considered empty",
|
|
7028
|
+
"returns": "`true` if the object is considered empty.",
|
|
7029
7029
|
"tags": [
|
|
7030
7030
|
"object",
|
|
7031
7031
|
"empty",
|
|
@@ -7054,17 +7054,17 @@
|
|
|
7054
7054
|
{
|
|
7055
7055
|
"name": "a",
|
|
7056
7056
|
"type": "F",
|
|
7057
|
-
"description": "- First value to compare",
|
|
7057
|
+
"description": "- First value to compare.",
|
|
7058
7058
|
"optional": false
|
|
7059
7059
|
},
|
|
7060
7060
|
{
|
|
7061
7061
|
"name": "b",
|
|
7062
7062
|
"type": "F",
|
|
7063
|
-
"description": "- Second value to compare",
|
|
7063
|
+
"description": "- Second value to compare.",
|
|
7064
7064
|
"optional": false
|
|
7065
7065
|
}
|
|
7066
7066
|
],
|
|
7067
|
-
"returns": "`true` if the values are deeply equal",
|
|
7067
|
+
"returns": "`true` if the values are deeply equal.",
|
|
7068
7068
|
"tags": [
|
|
7069
7069
|
"object",
|
|
7070
7070
|
"equal",
|
|
@@ -7095,11 +7095,11 @@
|
|
|
7095
7095
|
{
|
|
7096
7096
|
"name": "config",
|
|
7097
7097
|
"type": "ObjectFieldEqualityCheckerConfig<T>",
|
|
7098
|
-
"description": "- Configuration with the fields to compare and an optional default equality function",
|
|
7098
|
+
"description": "- Configuration with the fields to compare and an optional default equality function.",
|
|
7099
7099
|
"optional": false
|
|
7100
7100
|
}
|
|
7101
7101
|
],
|
|
7102
|
-
"returns": "
|
|
7102
|
+
"returns": "Compares two objects and reports which fields are equal/unequal.",
|
|
7103
7103
|
"tags": [
|
|
7104
7104
|
"object",
|
|
7105
7105
|
"equality",
|
|
@@ -7138,7 +7138,7 @@
|
|
|
7138
7138
|
"optional": true
|
|
7139
7139
|
}
|
|
7140
7140
|
],
|
|
7141
|
-
"returns": "
|
|
7141
|
+
"returns": "Returns the stripped object, or `undefined` when filtering removed every key.",
|
|
7142
7142
|
"tags": [
|
|
7143
7143
|
"object",
|
|
7144
7144
|
"strip",
|
|
@@ -7423,7 +7423,7 @@
|
|
|
7423
7423
|
"optional": true
|
|
7424
7424
|
}
|
|
7425
7425
|
],
|
|
7426
|
-
"returns": "
|
|
7426
|
+
"returns": "Filters keys on any input POJO.",
|
|
7427
7427
|
"tags": [
|
|
7428
7428
|
"object",
|
|
7429
7429
|
"pojo",
|
|
@@ -7459,7 +7459,7 @@
|
|
|
7459
7459
|
"optional": false
|
|
7460
7460
|
}
|
|
7461
7461
|
],
|
|
7462
|
-
"returns": "
|
|
7462
|
+
"returns": "Filters entries on any input POJO.",
|
|
7463
7463
|
"tags": [
|
|
7464
7464
|
"object",
|
|
7465
7465
|
"pojo",
|
|
@@ -7494,7 +7494,7 @@
|
|
|
7494
7494
|
"optional": false
|
|
7495
7495
|
}
|
|
7496
7496
|
],
|
|
7497
|
-
"returns": "
|
|
7497
|
+
"returns": "Iterates matching key/value pairs on any input object.",
|
|
7498
7498
|
"tags": [
|
|
7499
7499
|
"object",
|
|
7500
7500
|
"pojo",
|
|
@@ -7530,11 +7530,11 @@
|
|
|
7530
7530
|
{
|
|
7531
7531
|
"name": "filter",
|
|
7532
7532
|
"type": "FilterKeyValueTuplesInput<T, K>",
|
|
7533
|
-
"description": "- Optional filter configuration",
|
|
7533
|
+
"description": "- Optional filter configuration.",
|
|
7534
7534
|
"optional": true
|
|
7535
7535
|
}
|
|
7536
7536
|
],
|
|
7537
|
-
"returns": "
|
|
7537
|
+
"returns": "Extracts filtered tuples from any input object.",
|
|
7538
7538
|
"tags": [
|
|
7539
7539
|
"object",
|
|
7540
7540
|
"tuples",
|
|
@@ -7569,7 +7569,7 @@
|
|
|
7569
7569
|
"optional": false
|
|
7570
7570
|
}
|
|
7571
7571
|
],
|
|
7572
|
-
"returns": "A predicate function that tests individual key/value tuples",
|
|
7572
|
+
"returns": "A predicate function that tests individual key/value tuples.",
|
|
7573
7573
|
"tags": [
|
|
7574
7574
|
"object",
|
|
7575
7575
|
"tuple",
|
|
@@ -7636,11 +7636,11 @@
|
|
|
7636
7636
|
{
|
|
7637
7637
|
"name": "readKey",
|
|
7638
7638
|
"type": "ReadKeyFunction<T, K> | ReadMultipleKeysFunction<T, K>",
|
|
7639
|
-
"description": "- Function to extract one or more keys from each object",
|
|
7639
|
+
"description": "- Function to extract one or more keys from each object.",
|
|
7640
7640
|
"optional": false
|
|
7641
7641
|
}
|
|
7642
7642
|
],
|
|
7643
|
-
"returns": "An equality comparator for arrays of keyed objects",
|
|
7643
|
+
"returns": "An equality comparator for arrays of keyed objects.",
|
|
7644
7644
|
"tags": [
|
|
7645
7645
|
"object",
|
|
7646
7646
|
"key",
|
|
@@ -7670,11 +7670,11 @@
|
|
|
7670
7670
|
{
|
|
7671
7671
|
"name": "readKey",
|
|
7672
7672
|
"type": "ReadKeyFunction<T, K>",
|
|
7673
|
-
"description": "- Function to extract the key from an object",
|
|
7673
|
+
"description": "- Function to extract the key from an object.",
|
|
7674
7674
|
"optional": false
|
|
7675
7675
|
}
|
|
7676
7676
|
],
|
|
7677
|
-
"returns": "An equality comparator for keyed objects",
|
|
7677
|
+
"returns": "An equality comparator for keyed objects.",
|
|
7678
7678
|
"tags": [
|
|
7679
7679
|
"object",
|
|
7680
7680
|
"key",
|
|
@@ -7706,7 +7706,7 @@
|
|
|
7706
7706
|
"optional": false
|
|
7707
7707
|
}
|
|
7708
7708
|
],
|
|
7709
|
-
"returns": "
|
|
7709
|
+
"returns": "Maps all values in an input object map.",
|
|
7710
7710
|
"tags": [
|
|
7711
7711
|
"object",
|
|
7712
7712
|
"map",
|
|
@@ -7734,11 +7734,11 @@
|
|
|
7734
7734
|
{
|
|
7735
7735
|
"name": "mapKeyFn",
|
|
7736
7736
|
"type": "MapObjectKeyFunction<M>",
|
|
7737
|
-
"description": "- Function that computes the new key from the old key and its value",
|
|
7737
|
+
"description": "- Function that computes the new key from the old key and its value.",
|
|
7738
7738
|
"optional": false
|
|
7739
7739
|
}
|
|
7740
7740
|
],
|
|
7741
|
-
"returns": "
|
|
7741
|
+
"returns": "Remaps keys on any input object.",
|
|
7742
7742
|
"tags": [
|
|
7743
7743
|
"object",
|
|
7744
7744
|
"map",
|
|
@@ -7767,11 +7767,11 @@
|
|
|
7767
7767
|
{
|
|
7768
7768
|
"name": "obj",
|
|
7769
7769
|
"type": "object",
|
|
7770
|
-
"description": "- Object to check",
|
|
7770
|
+
"description": "- Object to check.",
|
|
7771
7771
|
"optional": false
|
|
7772
7772
|
}
|
|
7773
7773
|
],
|
|
7774
|
-
"returns": "`true` if the object has zero keys",
|
|
7774
|
+
"returns": "`true` if the object has zero keys.",
|
|
7775
7775
|
"tags": [
|
|
7776
7776
|
"object",
|
|
7777
7777
|
"empty",
|
|
@@ -7882,11 +7882,11 @@
|
|
|
7882
7882
|
{
|
|
7883
7883
|
"name": "map",
|
|
7884
7884
|
"type": "Map<K, T>",
|
|
7885
|
-
"description": "- Map to convert",
|
|
7885
|
+
"description": "- Map to convert.",
|
|
7886
7886
|
"optional": false
|
|
7887
7887
|
}
|
|
7888
7888
|
],
|
|
7889
|
-
"returns": "A plain object with the same key-value pairs",
|
|
7889
|
+
"returns": "A plain object with the same key-value pairs.",
|
|
7890
7890
|
"tags": [
|
|
7891
7891
|
"object",
|
|
7892
7892
|
"map",
|
|
@@ -7910,11 +7910,11 @@
|
|
|
7910
7910
|
{
|
|
7911
7911
|
"name": "input",
|
|
7912
7912
|
"type": "T",
|
|
7913
|
-
"description": "- Object to copy",
|
|
7913
|
+
"description": "- Object to copy.",
|
|
7914
7914
|
"optional": false
|
|
7915
7915
|
}
|
|
7916
7916
|
],
|
|
7917
|
-
"returns": "A new object with the same properties",
|
|
7917
|
+
"returns": "A new object with the same properties.",
|
|
7918
7918
|
"tags": [
|
|
7919
7919
|
"object",
|
|
7920
7920
|
"copy",
|
|
@@ -8293,7 +8293,7 @@
|
|
|
8293
8293
|
"optional": false
|
|
8294
8294
|
}
|
|
8295
8295
|
],
|
|
8296
|
-
"returns": "
|
|
8296
|
+
"returns": "Transforms paths to the specified start type.",
|
|
8297
8297
|
"tags": [
|
|
8298
8298
|
"path",
|
|
8299
8299
|
"slash",
|
|
@@ -8361,7 +8361,7 @@
|
|
|
8361
8361
|
{
|
|
8362
8362
|
"name": "config",
|
|
8363
8363
|
"type": "SlashPathFolderFactoryConfig",
|
|
8364
|
-
"description": "Configuration options for the factory.",
|
|
8364
|
+
"description": "- Configuration options for the factory.",
|
|
8365
8365
|
"optional": true
|
|
8366
8366
|
}
|
|
8367
8367
|
],
|
|
@@ -8395,17 +8395,17 @@
|
|
|
8395
8395
|
{
|
|
8396
8396
|
"name": "input",
|
|
8397
8397
|
"type": "string",
|
|
8398
|
-
"description": "-
|
|
8398
|
+
"description": "- The string path to convert to a folder path.",
|
|
8399
8399
|
"optional": false
|
|
8400
8400
|
},
|
|
8401
8401
|
{
|
|
8402
8402
|
"name": "config",
|
|
8403
8403
|
"type": "SlashPathFolderFactoryConfig",
|
|
8404
|
-
"description": "-
|
|
8404
|
+
"description": "- Optional configuration controlling path type inference and invalid-path handling.",
|
|
8405
8405
|
"optional": true
|
|
8406
8406
|
}
|
|
8407
8407
|
],
|
|
8408
|
-
"returns": "
|
|
8408
|
+
"returns": "A valid slash path folder string with a trailing slash, or an empty string for relative root.",
|
|
8409
8409
|
"tags": [
|
|
8410
8410
|
"path",
|
|
8411
8411
|
"slash",
|
|
@@ -8617,7 +8617,7 @@
|
|
|
8617
8617
|
{
|
|
8618
8618
|
"name": "input",
|
|
8619
8619
|
"type": "SlashPath",
|
|
8620
|
-
"description": "A slash path.",
|
|
8620
|
+
"description": "- A slash path.",
|
|
8621
8621
|
"optional": false
|
|
8622
8622
|
}
|
|
8623
8623
|
],
|
|
@@ -8741,7 +8741,7 @@
|
|
|
8741
8741
|
"optional": true
|
|
8742
8742
|
}
|
|
8743
8743
|
],
|
|
8744
|
-
"returns": "
|
|
8744
|
+
"returns": "Validates and fixes a slash path.",
|
|
8745
8745
|
"tags": [
|
|
8746
8746
|
"path",
|
|
8747
8747
|
"slash",
|
|
@@ -8915,7 +8915,7 @@
|
|
|
8915
8915
|
"optional": false
|
|
8916
8916
|
}
|
|
8917
8917
|
],
|
|
8918
|
-
"returns": "
|
|
8918
|
+
"returns": "Isolates path segments within the configured range.",
|
|
8919
8919
|
"tags": [
|
|
8920
8920
|
"path",
|
|
8921
8921
|
"slash",
|
|
@@ -8947,7 +8947,7 @@
|
|
|
8947
8947
|
{
|
|
8948
8948
|
"name": "path",
|
|
8949
8949
|
"type": "SlashPath",
|
|
8950
|
-
"description": "The path to get details for.",
|
|
8950
|
+
"description": "- The path to get details for.",
|
|
8951
8951
|
"optional": false
|
|
8952
8952
|
}
|
|
8953
8953
|
],
|
|
@@ -9022,7 +9022,7 @@
|
|
|
9022
9022
|
{
|
|
9023
9023
|
"name": "input",
|
|
9024
9024
|
"type": "SlashPathPathMatcherConfigInput<N>",
|
|
9025
|
-
"description": "The configuration input.",
|
|
9025
|
+
"description": "- The configuration input.",
|
|
9026
9026
|
"optional": false
|
|
9027
9027
|
}
|
|
9028
9028
|
],
|
|
@@ -9054,7 +9054,7 @@
|
|
|
9054
9054
|
{
|
|
9055
9055
|
"name": "input",
|
|
9056
9056
|
"type": "SlashPathPathMatcherConfigInput<N>",
|
|
9057
|
-
"description": "-
|
|
9057
|
+
"description": "- The matcher configuration, which may be a target path string, an array of path parts, or a full config object.",
|
|
9058
9058
|
"optional": false
|
|
9059
9059
|
}
|
|
9060
9060
|
],
|
|
@@ -9089,7 +9089,7 @@
|
|
|
9089
9089
|
{
|
|
9090
9090
|
"name": "config",
|
|
9091
9091
|
"type": "SlashPathSubPathMatcherConfig",
|
|
9092
|
-
"description": "The configuration for the matcher.",
|
|
9092
|
+
"description": "- The configuration for the matcher.",
|
|
9093
9093
|
"optional": false
|
|
9094
9094
|
}
|
|
9095
9095
|
],
|
|
@@ -9194,7 +9194,7 @@
|
|
|
9194
9194
|
"optional": false
|
|
9195
9195
|
}
|
|
9196
9196
|
],
|
|
9197
|
-
"returns": "
|
|
9197
|
+
"returns": "Resolves when the check condition returns `true` or the max attempts are exhausted.",
|
|
9198
9198
|
"tags": [
|
|
9199
9199
|
"promise",
|
|
9200
9200
|
"poll",
|
|
@@ -9226,7 +9226,7 @@
|
|
|
9226
9226
|
"optional": false
|
|
9227
9227
|
}
|
|
9228
9228
|
],
|
|
9229
|
-
"returns": "
|
|
9229
|
+
"returns": "Tries each factory in order for a given input.",
|
|
9230
9230
|
"tags": [
|
|
9231
9231
|
"promise",
|
|
9232
9232
|
"factory",
|
|
@@ -9256,7 +9256,7 @@
|
|
|
9256
9256
|
{
|
|
9257
9257
|
"name": "config",
|
|
9258
9258
|
"type": "RunNamedAsyncTasksFunctionConfig<T>",
|
|
9259
|
-
"description": "Optional configuration.",
|
|
9259
|
+
"description": "- Optional configuration.",
|
|
9260
9260
|
"optional": true
|
|
9261
9261
|
}
|
|
9262
9262
|
],
|
|
@@ -9346,7 +9346,7 @@
|
|
|
9346
9346
|
"optional": true
|
|
9347
9347
|
}
|
|
9348
9348
|
],
|
|
9349
|
-
"returns": "
|
|
9349
|
+
"returns": "The results produced by the task function for each input.",
|
|
9350
9350
|
"tags": [
|
|
9351
9351
|
"promise",
|
|
9352
9352
|
"async",
|
|
@@ -9468,7 +9468,7 @@
|
|
|
9468
9468
|
"optional": false
|
|
9469
9469
|
}
|
|
9470
9470
|
],
|
|
9471
|
-
"returns": "
|
|
9471
|
+
"returns": "Accepts an array of inputs and returns a Promise resolving when all tasks complete.",
|
|
9472
9472
|
"tags": [
|
|
9473
9473
|
"promise",
|
|
9474
9474
|
"parallel",
|
|
@@ -9503,7 +9503,7 @@
|
|
|
9503
9503
|
"optional": false
|
|
9504
9504
|
}
|
|
9505
9505
|
],
|
|
9506
|
-
"returns": "
|
|
9506
|
+
"returns": "Accepts a task input factory and returns a Promise that resolves when all tasks complete.",
|
|
9507
9507
|
"tags": [
|
|
9508
9508
|
"promise",
|
|
9509
9509
|
"parallel",
|
|
@@ -9569,7 +9569,7 @@
|
|
|
9569
9569
|
"optional": false
|
|
9570
9570
|
}
|
|
9571
9571
|
],
|
|
9572
|
-
"returns": "
|
|
9572
|
+
"returns": "Resolves to the input value.",
|
|
9573
9573
|
"tags": [
|
|
9574
9574
|
"promise",
|
|
9575
9575
|
"async",
|
|
@@ -9643,7 +9643,7 @@
|
|
|
9643
9643
|
"optional": false
|
|
9644
9644
|
}
|
|
9645
9645
|
],
|
|
9646
|
-
"returns": "
|
|
9646
|
+
"returns": "Accepts a handler function and registers it for the given key.",
|
|
9647
9647
|
"tags": [
|
|
9648
9648
|
"service",
|
|
9649
9649
|
"handler",
|
|
@@ -9687,7 +9687,7 @@
|
|
|
9687
9687
|
"optional": false
|
|
9688
9688
|
}
|
|
9689
9689
|
],
|
|
9690
|
-
"returns": "
|
|
9690
|
+
"returns": "Accepts a mapped handler function and registers it.",
|
|
9691
9691
|
"tags": [
|
|
9692
9692
|
"service",
|
|
9693
9693
|
"handler",
|
|
@@ -9901,7 +9901,7 @@
|
|
|
9901
9901
|
"optional": false
|
|
9902
9902
|
}
|
|
9903
9903
|
],
|
|
9904
|
-
"returns": "
|
|
9904
|
+
"returns": "Compares two iterables and returns an array of change pairs.",
|
|
9905
9905
|
"tags": [
|
|
9906
9906
|
"set",
|
|
9907
9907
|
"delta",
|
|
@@ -10087,7 +10087,7 @@
|
|
|
10087
10087
|
"optional": true
|
|
10088
10088
|
}
|
|
10089
10089
|
],
|
|
10090
|
-
"returns": "
|
|
10090
|
+
"returns": "Tests membership.",
|
|
10091
10091
|
"tags": [
|
|
10092
10092
|
"set",
|
|
10093
10093
|
"has",
|
|
@@ -10127,7 +10127,7 @@
|
|
|
10127
10127
|
"optional": false
|
|
10128
10128
|
}
|
|
10129
10129
|
],
|
|
10130
|
-
"returns": "
|
|
10130
|
+
"returns": "Tests membership.",
|
|
10131
10131
|
"tags": [
|
|
10132
10132
|
"set",
|
|
10133
10133
|
"has",
|
|
@@ -10173,7 +10173,7 @@
|
|
|
10173
10173
|
"optional": true
|
|
10174
10174
|
}
|
|
10175
10175
|
],
|
|
10176
|
-
"returns": "
|
|
10176
|
+
"returns": "Tests inclusion against the set.",
|
|
10177
10177
|
"tags": [
|
|
10178
10178
|
"set",
|
|
10179
10179
|
"includes",
|
|
@@ -10203,7 +10203,7 @@
|
|
|
10203
10203
|
{
|
|
10204
10204
|
"name": "input",
|
|
10205
10205
|
"type": "string",
|
|
10206
|
-
"description": "The SCREAMING_SNAKE_CASE input.",
|
|
10206
|
+
"description": "- The SCREAMING_SNAKE_CASE input.",
|
|
10207
10207
|
"optional": false
|
|
10208
10208
|
}
|
|
10209
10209
|
],
|
|
@@ -10238,7 +10238,7 @@
|
|
|
10238
10238
|
{
|
|
10239
10239
|
"name": "input",
|
|
10240
10240
|
"type": "string",
|
|
10241
|
-
"description": "The camelCase / PascalCase input.",
|
|
10241
|
+
"description": "- The camelCase / PascalCase input.",
|
|
10242
10242
|
"optional": false
|
|
10243
10243
|
}
|
|
10244
10244
|
],
|
|
@@ -10276,17 +10276,17 @@
|
|
|
10276
10276
|
{
|
|
10277
10277
|
"name": "replacement",
|
|
10278
10278
|
"type": "string",
|
|
10279
|
-
"description": "-
|
|
10279
|
+
"description": "- String to substitute for the last character.",
|
|
10280
10280
|
"optional": false
|
|
10281
10281
|
},
|
|
10282
10282
|
{
|
|
10283
10283
|
"name": "is",
|
|
10284
10284
|
"type": "ArrayOrValue<string>",
|
|
10285
|
-
"description": "-
|
|
10285
|
+
"description": "- Character(s) that trigger the replacement.",
|
|
10286
10286
|
"optional": false
|
|
10287
10287
|
}
|
|
10288
10288
|
],
|
|
10289
|
-
"returns": "
|
|
10289
|
+
"returns": "Conditionally replaces the last character.",
|
|
10290
10290
|
"tags": [
|
|
10291
10291
|
"string",
|
|
10292
10292
|
"replace",
|
|
@@ -10317,11 +10317,11 @@
|
|
|
10317
10317
|
{
|
|
10318
10318
|
"name": "config",
|
|
10319
10319
|
"type": "PrimativeKeyDencoderConfig<D, E>",
|
|
10320
|
-
"description": "-
|
|
10320
|
+
"description": "- Configuration with value pairs and optional default fallback.",
|
|
10321
10321
|
"optional": false
|
|
10322
10322
|
}
|
|
10323
10323
|
],
|
|
10324
|
-
"returns": "
|
|
10324
|
+
"returns": "Encodes or decodes single values or arrays.",
|
|
10325
10325
|
"tags": [
|
|
10326
10326
|
"string",
|
|
10327
10327
|
"encode",
|
|
@@ -10352,11 +10352,11 @@
|
|
|
10352
10352
|
{
|
|
10353
10353
|
"name": "config",
|
|
10354
10354
|
"type": "PrimativeKeyStringDencoderConfig<D, E>",
|
|
10355
|
-
"description": "-
|
|
10355
|
+
"description": "- Configuration with dencoder and optional splitter.",
|
|
10356
10356
|
"optional": false
|
|
10357
10357
|
}
|
|
10358
10358
|
],
|
|
10359
|
-
"returns": "
|
|
10359
|
+
"returns": "A bidirectional function for string-to-array and array-to-string conversion.",
|
|
10360
10360
|
"tags": [
|
|
10361
10361
|
"string",
|
|
10362
10362
|
"encode",
|
|
@@ -10387,11 +10387,11 @@
|
|
|
10387
10387
|
{
|
|
10388
10388
|
"name": "dencoder",
|
|
10389
10389
|
"type": "NumberStringDencoder",
|
|
10390
|
-
"description": "-
|
|
10390
|
+
"description": "- The NumberStringDencoder to wrap.",
|
|
10391
10391
|
"optional": false
|
|
10392
10392
|
}
|
|
10393
10393
|
],
|
|
10394
|
-
"returns": "
|
|
10394
|
+
"returns": "A bidirectional encode/decode function.",
|
|
10395
10395
|
"tags": [
|
|
10396
10396
|
"string",
|
|
10397
10397
|
"number",
|
|
@@ -10422,11 +10422,11 @@
|
|
|
10422
10422
|
{
|
|
10423
10423
|
"name": "dencoder",
|
|
10424
10424
|
"type": "NumberStringDencoder",
|
|
10425
|
-
"description": "-
|
|
10425
|
+
"description": "- The NumberStringDencoder to use for encoding.",
|
|
10426
10426
|
"optional": false
|
|
10427
10427
|
}
|
|
10428
10428
|
],
|
|
10429
|
-
"returns": "
|
|
10429
|
+
"returns": "Normalizes input to an encoded string.",
|
|
10430
10430
|
"tags": [
|
|
10431
10431
|
"string",
|
|
10432
10432
|
"number",
|
|
@@ -10457,11 +10457,11 @@
|
|
|
10457
10457
|
{
|
|
10458
10458
|
"name": "dencoder",
|
|
10459
10459
|
"type": "NumberStringDencoder",
|
|
10460
|
-
"description": "-
|
|
10460
|
+
"description": "- The NumberStringDencoder to use for decoding.",
|
|
10461
10461
|
"optional": false
|
|
10462
10462
|
}
|
|
10463
10463
|
],
|
|
10464
|
-
"returns": "
|
|
10464
|
+
"returns": "Normalizes input to a decoded number.",
|
|
10465
10465
|
"tags": [
|
|
10466
10466
|
"string",
|
|
10467
10467
|
"number",
|
|
@@ -10492,17 +10492,17 @@
|
|
|
10492
10492
|
{
|
|
10493
10493
|
"name": "factory",
|
|
10494
10494
|
"type": "Factory<T>",
|
|
10495
|
-
"description": "-
|
|
10495
|
+
"description": "- The original value factory.",
|
|
10496
10496
|
"optional": false
|
|
10497
10497
|
},
|
|
10498
10498
|
{
|
|
10499
10499
|
"name": "toStringFunction",
|
|
10500
10500
|
"type": "ToStringFunction<T, K>",
|
|
10501
|
-
"description": "-
|
|
10501
|
+
"description": "- Function to convert the factory's output to a string.",
|
|
10502
10502
|
"optional": false
|
|
10503
10503
|
}
|
|
10504
10504
|
],
|
|
10505
|
-
"returns": "
|
|
10505
|
+
"returns": "A new factory that produces string values.",
|
|
10506
10506
|
"tags": [
|
|
10507
10507
|
"string",
|
|
10508
10508
|
"factory",
|
|
@@ -10530,7 +10530,7 @@
|
|
|
10530
10530
|
{
|
|
10531
10531
|
"name": "config",
|
|
10532
10532
|
"type": "StringFromDateConfig",
|
|
10533
|
-
"description": "Configuration for the factory.",
|
|
10533
|
+
"description": "- Configuration for the factory.",
|
|
10534
10534
|
"optional": false
|
|
10535
10535
|
}
|
|
10536
10536
|
],
|
|
@@ -10563,7 +10563,7 @@
|
|
|
10563
10563
|
{
|
|
10564
10564
|
"name": "digitsFromEnd",
|
|
10565
10565
|
"type": "number",
|
|
10566
|
-
"description": "The number of digits to return from the end of the generated string. Defaults to 7.",
|
|
10566
|
+
"description": "- The number of digits to return from the end of the generated string. Defaults to 7.",
|
|
10567
10567
|
"optional": true
|
|
10568
10568
|
}
|
|
10569
10569
|
],
|
|
@@ -10599,7 +10599,7 @@
|
|
|
10599
10599
|
"optional": false
|
|
10600
10600
|
}
|
|
10601
10601
|
],
|
|
10602
|
-
"returns": "
|
|
10602
|
+
"returns": "Performs the configured replacements on an input string.",
|
|
10603
10603
|
"tags": [
|
|
10604
10604
|
"string",
|
|
10605
10605
|
"replace",
|
|
@@ -10665,7 +10665,7 @@
|
|
|
10665
10665
|
"optional": false
|
|
10666
10666
|
}
|
|
10667
10667
|
],
|
|
10668
|
-
"returns": "
|
|
10668
|
+
"returns": "Escapes the configured characters in any input string.",
|
|
10669
10669
|
"tags": [
|
|
10670
10670
|
"string",
|
|
10671
10671
|
"escape",
|
|
@@ -10722,7 +10722,7 @@
|
|
|
10722
10722
|
"optional": false
|
|
10723
10723
|
}
|
|
10724
10724
|
],
|
|
10725
|
-
"returns": "
|
|
10725
|
+
"returns": "Finds all occurrences of the configured characters in an input string.",
|
|
10726
10726
|
"tags": [
|
|
10727
10727
|
"string",
|
|
10728
10728
|
"search",
|
|
@@ -10771,7 +10771,7 @@
|
|
|
10771
10771
|
"optional": true
|
|
10772
10772
|
}
|
|
10773
10773
|
],
|
|
10774
|
-
"returns": "
|
|
10774
|
+
"returns": "The zero-based indices where matching characters were found.",
|
|
10775
10775
|
"tags": [
|
|
10776
10776
|
"string",
|
|
10777
10777
|
"search",
|
|
@@ -10847,7 +10847,7 @@
|
|
|
10847
10847
|
"optional": false
|
|
10848
10848
|
}
|
|
10849
10849
|
],
|
|
10850
|
-
"returns": "
|
|
10850
|
+
"returns": "Splits input strings at the first matching character.",
|
|
10851
10851
|
"tags": [
|
|
10852
10852
|
"string",
|
|
10853
10853
|
"split",
|
|
@@ -10873,7 +10873,7 @@
|
|
|
10873
10873
|
"category": "string",
|
|
10874
10874
|
"module": "@dereekb/util",
|
|
10875
10875
|
"subpath": "string/replace",
|
|
10876
|
-
"signature": "splitStringAtFirstCharacterOccurence(input: string, splitAt: string | Set<string>): [string, string
|
|
10876
|
+
"signature": "splitStringAtFirstCharacterOccurence(input: string, splitAt: string | Set<string>): [string, Maybe<string>]",
|
|
10877
10877
|
"description": "Splits the input string into two parts at the first occurrence of any character in the split set.",
|
|
10878
10878
|
"params": [
|
|
10879
10879
|
{
|
|
@@ -10924,7 +10924,7 @@
|
|
|
10924
10924
|
"optional": false
|
|
10925
10925
|
}
|
|
10926
10926
|
],
|
|
10927
|
-
"returns": "
|
|
10927
|
+
"returns": "Extracts the substring after the first matching character, or an empty string if none found.",
|
|
10928
10928
|
"tags": [
|
|
10929
10929
|
"string",
|
|
10930
10930
|
"keep",
|
|
@@ -11002,7 +11002,7 @@
|
|
|
11002
11002
|
"optional": false
|
|
11003
11003
|
}
|
|
11004
11004
|
],
|
|
11005
|
-
"returns": "
|
|
11005
|
+
"returns": "Truncates input strings at the first matching character.",
|
|
11006
11006
|
"tags": [
|
|
11007
11007
|
"string",
|
|
11008
11008
|
"remove",
|
|
@@ -11082,7 +11082,7 @@
|
|
|
11082
11082
|
"optional": false
|
|
11083
11083
|
}
|
|
11084
11084
|
],
|
|
11085
|
-
"returns": "
|
|
11085
|
+
"returns": "Filters an array of values by a search/filter text string.",
|
|
11086
11086
|
"tags": [
|
|
11087
11087
|
"string",
|
|
11088
11088
|
"search",
|
|
@@ -11097,6 +11097,85 @@
|
|
|
11097
11097
|
"case-insensitive-filter-by-index-of-decision-factory"
|
|
11098
11098
|
]
|
|
11099
11099
|
},
|
|
11100
|
+
{
|
|
11101
|
+
"slug": "compare-strings",
|
|
11102
|
+
"name": "compareStrings",
|
|
11103
|
+
"kind": "const",
|
|
11104
|
+
"category": "string",
|
|
11105
|
+
"module": "@dereekb/util",
|
|
11106
|
+
"subpath": "string/sort",
|
|
11107
|
+
"signature": "const compareStrings: number",
|
|
11108
|
+
"description": "Pre-configured comparator that sorts strings in ascending alphabetical order using `localeCompare`.\n\nUse this directly with `Array.sort()` / `Array.toSorted()` instead of inlining\n`(a, b) => a.localeCompare(b)` everywhere, and to satisfy the no-default-sort\nlint rule for string arrays.",
|
|
11109
|
+
"params": [
|
|
11110
|
+
{
|
|
11111
|
+
"name": "a",
|
|
11112
|
+
"type": "string",
|
|
11113
|
+
"description": "- The first string to compare.",
|
|
11114
|
+
"optional": false
|
|
11115
|
+
},
|
|
11116
|
+
{
|
|
11117
|
+
"name": "b",
|
|
11118
|
+
"type": "string",
|
|
11119
|
+
"description": "- The second string to compare.",
|
|
11120
|
+
"optional": false
|
|
11121
|
+
}
|
|
11122
|
+
],
|
|
11123
|
+
"returns": "A negative number when `a` sorts before `b`, positive when after, `0` when equal.",
|
|
11124
|
+
"tags": [
|
|
11125
|
+
"string",
|
|
11126
|
+
"sort",
|
|
11127
|
+
"compare",
|
|
11128
|
+
"alphabetical",
|
|
11129
|
+
"locale",
|
|
11130
|
+
"strings",
|
|
11131
|
+
"comparestrings"
|
|
11132
|
+
],
|
|
11133
|
+
"example": "['b', 'a', 'c'].sort(compareStrings); // ['a', 'b', 'c']",
|
|
11134
|
+
"relatedSlugs": [
|
|
11135
|
+
"compare-strings-numeric",
|
|
11136
|
+
"sort-by-string-function"
|
|
11137
|
+
]
|
|
11138
|
+
},
|
|
11139
|
+
{
|
|
11140
|
+
"slug": "compare-strings-numeric",
|
|
11141
|
+
"name": "compareStringsNumeric",
|
|
11142
|
+
"kind": "const",
|
|
11143
|
+
"category": "string",
|
|
11144
|
+
"module": "@dereekb/util",
|
|
11145
|
+
"subpath": "string/sort",
|
|
11146
|
+
"signature": "const compareStringsNumeric: number",
|
|
11147
|
+
"description": "Pre-configured comparator that sorts strings in ascending order using `localeCompare`\nwith the `numeric` collation option enabled, so numeric substrings are compared by value\n(e.g. `\"2\"` sorts before `\"10\"`).",
|
|
11148
|
+
"params": [
|
|
11149
|
+
{
|
|
11150
|
+
"name": "a",
|
|
11151
|
+
"type": "string",
|
|
11152
|
+
"description": "- The first string to compare.",
|
|
11153
|
+
"optional": false
|
|
11154
|
+
},
|
|
11155
|
+
{
|
|
11156
|
+
"name": "b",
|
|
11157
|
+
"type": "string",
|
|
11158
|
+
"description": "- The second string to compare.",
|
|
11159
|
+
"optional": false
|
|
11160
|
+
}
|
|
11161
|
+
],
|
|
11162
|
+
"returns": "A negative number when `a` sorts before `b`, positive when after, `0` when equal.",
|
|
11163
|
+
"tags": [
|
|
11164
|
+
"string",
|
|
11165
|
+
"sort",
|
|
11166
|
+
"compare",
|
|
11167
|
+
"numeric",
|
|
11168
|
+
"natural",
|
|
11169
|
+
"locale",
|
|
11170
|
+
"strings",
|
|
11171
|
+
"comparestringsnumeric"
|
|
11172
|
+
],
|
|
11173
|
+
"example": "['10', '2', '1'].sort(compareStringsNumeric); // ['1', '2', '10']",
|
|
11174
|
+
"relatedSlugs": [
|
|
11175
|
+
"compare-strings",
|
|
11176
|
+
"sort-by-string-function"
|
|
11177
|
+
]
|
|
11178
|
+
},
|
|
11100
11179
|
{
|
|
11101
11180
|
"slug": "sort-by-string-function",
|
|
11102
11181
|
"name": "sortByStringFunction",
|
|
@@ -11190,23 +11269,23 @@
|
|
|
11190
11269
|
{
|
|
11191
11270
|
"name": "input",
|
|
11192
11271
|
"type": "string",
|
|
11193
|
-
"description": "-
|
|
11272
|
+
"description": "- String to split.",
|
|
11194
11273
|
"optional": false
|
|
11195
11274
|
},
|
|
11196
11275
|
{
|
|
11197
11276
|
"name": "separator",
|
|
11198
11277
|
"type": "string",
|
|
11199
|
-
"description": "-
|
|
11278
|
+
"description": "- Delimiter to split on.",
|
|
11200
11279
|
"optional": false
|
|
11201
11280
|
},
|
|
11202
11281
|
{
|
|
11203
11282
|
"name": "limit",
|
|
11204
11283
|
"type": "number",
|
|
11205
|
-
"description": "-
|
|
11284
|
+
"description": "- Maximum number of resulting segments; overflow segments are rejoined with the separator.",
|
|
11206
11285
|
"optional": false
|
|
11207
11286
|
}
|
|
11208
11287
|
],
|
|
11209
|
-
"returns": "
|
|
11288
|
+
"returns": "Array of string segments, with length at most equal to limit.",
|
|
11210
11289
|
"tags": [
|
|
11211
11290
|
"string",
|
|
11212
11291
|
"split",
|
|
@@ -11268,11 +11347,11 @@
|
|
|
11268
11347
|
{
|
|
11269
11348
|
"name": "value",
|
|
11270
11349
|
"type": "string",
|
|
11271
|
-
"description": "-
|
|
11350
|
+
"description": "- String to capitalize.",
|
|
11272
11351
|
"optional": false
|
|
11273
11352
|
}
|
|
11274
11353
|
],
|
|
11275
|
-
"returns": "
|
|
11354
|
+
"returns": "The input string with its first character uppercased.",
|
|
11276
11355
|
"tags": [
|
|
11277
11356
|
"string",
|
|
11278
11357
|
"capitalize",
|
|
@@ -11300,11 +11379,11 @@
|
|
|
11300
11379
|
{
|
|
11301
11380
|
"name": "value",
|
|
11302
11381
|
"type": "string",
|
|
11303
|
-
"description": "-
|
|
11382
|
+
"description": "- String to modify.",
|
|
11304
11383
|
"optional": false
|
|
11305
11384
|
}
|
|
11306
11385
|
],
|
|
11307
|
-
"returns": "
|
|
11386
|
+
"returns": "The input string with its first character lowercased.",
|
|
11308
11387
|
"tags": [
|
|
11309
11388
|
"string",
|
|
11310
11389
|
"lowercase",
|
|
@@ -11332,11 +11411,11 @@
|
|
|
11332
11411
|
{
|
|
11333
11412
|
"name": "input",
|
|
11334
11413
|
"type": "string",
|
|
11335
|
-
"description": "-
|
|
11414
|
+
"description": "- Full name string to split.",
|
|
11336
11415
|
"optional": false
|
|
11337
11416
|
}
|
|
11338
11417
|
],
|
|
11339
|
-
"returns": "
|
|
11418
|
+
"returns": "A tuple of [firstName, lastName], where lastName includes all text after the first space.",
|
|
11340
11419
|
"tags": [
|
|
11341
11420
|
"string",
|
|
11342
11421
|
"name",
|
|
@@ -11365,17 +11444,17 @@
|
|
|
11365
11444
|
{
|
|
11366
11445
|
"name": "string",
|
|
11367
11446
|
"type": "string",
|
|
11368
|
-
"description": "-
|
|
11447
|
+
"description": "- The string to repeat.",
|
|
11369
11448
|
"optional": false
|
|
11370
11449
|
},
|
|
11371
11450
|
{
|
|
11372
11451
|
"name": "reapeat",
|
|
11373
11452
|
"type": "number",
|
|
11374
|
-
"description": "-
|
|
11453
|
+
"description": "- Number of times to repeat the string.",
|
|
11375
11454
|
"optional": false
|
|
11376
11455
|
}
|
|
11377
11456
|
],
|
|
11378
|
-
"returns": "
|
|
11457
|
+
"returns": "The repeated string concatenation.",
|
|
11379
11458
|
"tags": [
|
|
11380
11459
|
"string",
|
|
11381
11460
|
"repeat",
|
|
@@ -11398,11 +11477,11 @@
|
|
|
11398
11477
|
{
|
|
11399
11478
|
"name": "config",
|
|
11400
11479
|
"type": "CutStringFunctionConfig",
|
|
11401
|
-
"description": "-
|
|
11480
|
+
"description": "- Configuration controlling max length and end text behavior.",
|
|
11402
11481
|
"optional": false
|
|
11403
11482
|
}
|
|
11404
11483
|
],
|
|
11405
|
-
"returns": "
|
|
11484
|
+
"returns": "A reusable function that truncates input strings.",
|
|
11406
11485
|
"tags": [
|
|
11407
11486
|
"string",
|
|
11408
11487
|
"cut",
|
|
@@ -11428,23 +11507,23 @@
|
|
|
11428
11507
|
{
|
|
11429
11508
|
"name": "input",
|
|
11430
11509
|
"type": "Maybe<string>",
|
|
11431
|
-
"description": "-
|
|
11510
|
+
"description": "- The string to truncate, or null/undefined.",
|
|
11432
11511
|
"optional": false
|
|
11433
11512
|
},
|
|
11434
11513
|
{
|
|
11435
11514
|
"name": "maxLength",
|
|
11436
11515
|
"type": "number",
|
|
11437
|
-
"description": "-
|
|
11516
|
+
"description": "- Maximum allowed length for the output string.",
|
|
11438
11517
|
"optional": false
|
|
11439
11518
|
},
|
|
11440
11519
|
{
|
|
11441
11520
|
"name": "endText",
|
|
11442
11521
|
"type": "Maybe<string>",
|
|
11443
|
-
"description": "-
|
|
11522
|
+
"description": "- Text to append when truncated; defaults to \"...\".",
|
|
11444
11523
|
"optional": true
|
|
11445
11524
|
}
|
|
11446
11525
|
],
|
|
11447
|
-
"returns": "
|
|
11526
|
+
"returns": "The truncated string, or null/undefined if the input is null/undefined.",
|
|
11448
11527
|
"tags": [
|
|
11449
11528
|
"string",
|
|
11450
11529
|
"cut",
|
|
@@ -11472,11 +11551,11 @@
|
|
|
11472
11551
|
{
|
|
11473
11552
|
"name": "input",
|
|
11474
11553
|
"type": "string",
|
|
11475
|
-
"description": "-
|
|
11554
|
+
"description": "- String to flatten.",
|
|
11476
11555
|
"optional": false
|
|
11477
11556
|
}
|
|
11478
11557
|
],
|
|
11479
|
-
"returns": "
|
|
11558
|
+
"returns": "The string with collapsed whitespace.",
|
|
11480
11559
|
"tags": [
|
|
11481
11560
|
"string",
|
|
11482
11561
|
"whitespace",
|
|
@@ -11503,11 +11582,11 @@
|
|
|
11503
11582
|
{
|
|
11504
11583
|
"name": "input",
|
|
11505
11584
|
"type": "string",
|
|
11506
|
-
"description": "-
|
|
11585
|
+
"description": "- String to simplify.",
|
|
11507
11586
|
"optional": false
|
|
11508
11587
|
}
|
|
11509
11588
|
],
|
|
11510
|
-
"returns": "
|
|
11589
|
+
"returns": "The string with simplified whitespace and newlines.",
|
|
11511
11590
|
"tags": [
|
|
11512
11591
|
"string",
|
|
11513
11592
|
"whitespace",
|
|
@@ -11534,7 +11613,7 @@
|
|
|
11534
11613
|
{
|
|
11535
11614
|
"name": "input",
|
|
11536
11615
|
"type": "string",
|
|
11537
|
-
"description": "The string to trim.",
|
|
11616
|
+
"description": "- The string to trim.",
|
|
11538
11617
|
"optional": false
|
|
11539
11618
|
}
|
|
11540
11619
|
],
|
|
@@ -11564,7 +11643,7 @@
|
|
|
11564
11643
|
{
|
|
11565
11644
|
"name": "input",
|
|
11566
11645
|
"type": "string",
|
|
11567
|
-
"description": "The string to convert.",
|
|
11646
|
+
"description": "- The string to convert.",
|
|
11568
11647
|
"optional": false
|
|
11569
11648
|
}
|
|
11570
11649
|
],
|
|
@@ -11596,7 +11675,7 @@
|
|
|
11596
11675
|
{
|
|
11597
11676
|
"name": "input",
|
|
11598
11677
|
"type": "string",
|
|
11599
|
-
"description": "The string to convert.",
|
|
11678
|
+
"description": "- The string to convert.",
|
|
11600
11679
|
"optional": false
|
|
11601
11680
|
}
|
|
11602
11681
|
],
|
|
@@ -11628,7 +11707,7 @@
|
|
|
11628
11707
|
{
|
|
11629
11708
|
"name": "config",
|
|
11630
11709
|
"type": "TransformStringFunctionConfig<S>",
|
|
11631
|
-
"description": "The `TransformStringFunctionConfig` detailing the transformations.",
|
|
11710
|
+
"description": "- The `TransformStringFunctionConfig` detailing the transformations.",
|
|
11632
11711
|
"optional": false
|
|
11633
11712
|
}
|
|
11634
11713
|
],
|
|
@@ -11663,11 +11742,11 @@
|
|
|
11663
11742
|
{
|
|
11664
11743
|
"name": "prefix",
|
|
11665
11744
|
"type": "string",
|
|
11666
|
-
"description": "The prefix to add.",
|
|
11745
|
+
"description": "- The prefix to add.",
|
|
11667
11746
|
"optional": false
|
|
11668
11747
|
}
|
|
11669
11748
|
],
|
|
11670
|
-
"returns": "
|
|
11749
|
+
"returns": "Adds the prefix to a string.",
|
|
11671
11750
|
"tags": [
|
|
11672
11751
|
"string",
|
|
11673
11752
|
"prefix",
|
|
@@ -11694,11 +11773,11 @@
|
|
|
11694
11773
|
{
|
|
11695
11774
|
"name": "suffix",
|
|
11696
11775
|
"type": "string",
|
|
11697
|
-
"description": "The suffix to add.",
|
|
11776
|
+
"description": "- The suffix to add.",
|
|
11698
11777
|
"optional": false
|
|
11699
11778
|
}
|
|
11700
11779
|
],
|
|
11701
|
-
"returns": "
|
|
11780
|
+
"returns": "Adds the suffix to a string.",
|
|
11702
11781
|
"tags": [
|
|
11703
11782
|
"string",
|
|
11704
11783
|
"suffix",
|
|
@@ -11725,17 +11804,17 @@
|
|
|
11725
11804
|
{
|
|
11726
11805
|
"name": "minLength",
|
|
11727
11806
|
"type": "number",
|
|
11728
|
-
"description": "The minimum length of the string.",
|
|
11807
|
+
"description": "- The minimum length of the string.",
|
|
11729
11808
|
"optional": false
|
|
11730
11809
|
},
|
|
11731
11810
|
{
|
|
11732
11811
|
"name": "padCharacter",
|
|
11733
11812
|
"type": "string",
|
|
11734
|
-
"description": "The character to use for padding.",
|
|
11813
|
+
"description": "- The character to use for padding.",
|
|
11735
11814
|
"optional": false
|
|
11736
11815
|
}
|
|
11737
11816
|
],
|
|
11738
|
-
"returns": "
|
|
11817
|
+
"returns": "Pads the start of a string.",
|
|
11739
11818
|
"tags": [
|
|
11740
11819
|
"string",
|
|
11741
11820
|
"pad",
|
|
@@ -11762,7 +11841,7 @@
|
|
|
11762
11841
|
{
|
|
11763
11842
|
"name": "config",
|
|
11764
11843
|
"type": "SliceStringFunctionConfig",
|
|
11765
|
-
"description": "The configuration for the slice function.",
|
|
11844
|
+
"description": "- The configuration for the slice function.",
|
|
11766
11845
|
"optional": false
|
|
11767
11846
|
}
|
|
11768
11847
|
],
|
|
@@ -11830,7 +11909,7 @@
|
|
|
11830
11909
|
"optional": true
|
|
11831
11910
|
}
|
|
11832
11911
|
],
|
|
11833
|
-
"returns": "
|
|
11912
|
+
"returns": "Isolates the configured portion of a website path.",
|
|
11834
11913
|
"tags": [
|
|
11835
11914
|
"string",
|
|
11836
11915
|
"url",
|
|
@@ -11862,13 +11941,13 @@
|
|
|
11862
11941
|
{
|
|
11863
11942
|
"name": "expand",
|
|
11864
11943
|
"type": "ExpandTreeFunction<T, N>",
|
|
11865
|
-
"description": "An ExpandTreeFunction (values: T[]) => N[] that converts an array of T into an array of tree nodes N.",
|
|
11944
|
+
"description": "- An ExpandTreeFunction (values: T[]) => N[] that converts an array of T into an array of tree nodes N.",
|
|
11866
11945
|
"optional": false
|
|
11867
11946
|
},
|
|
11868
11947
|
{
|
|
11869
11948
|
"name": "flatten",
|
|
11870
11949
|
"type": "FlattenTreeFunction<N, V>",
|
|
11871
|
-
"description": "A FlattenTreeFunction (tree: N, array?: V[]) => V[] that flattens a tree of N nodes into an array of V values.",
|
|
11950
|
+
"description": "- A FlattenTreeFunction (tree: N, array?: V[]) => V[] that flattens a tree of N nodes into an array of V values.",
|
|
11872
11951
|
"optional": false
|
|
11873
11952
|
}
|
|
11874
11953
|
],
|
|
@@ -11902,7 +11981,7 @@
|
|
|
11902
11981
|
{
|
|
11903
11982
|
"name": "config",
|
|
11904
11983
|
"type": "ExpandTree<T> | ExpandTreeWithNodeBuilder<T, N>",
|
|
11905
|
-
"description": "An ExpandTree<T> or ExpandTreeWithNodeBuilder<T, N> configuration object.",
|
|
11984
|
+
"description": "- An ExpandTree<T> or ExpandTreeWithNodeBuilder<T, N> configuration object.",
|
|
11906
11985
|
"optional": false
|
|
11907
11986
|
}
|
|
11908
11987
|
],
|
|
@@ -11938,17 +12017,17 @@
|
|
|
11938
12017
|
{
|
|
11939
12018
|
"name": "values",
|
|
11940
12019
|
"type": "T[]",
|
|
11941
|
-
"description": "
|
|
12020
|
+
"description": "- The root values of type T to expand.",
|
|
11942
12021
|
"optional": false
|
|
11943
12022
|
},
|
|
11944
12023
|
{
|
|
11945
12024
|
"name": "expandFn",
|
|
11946
12025
|
"type": "ExpandTreeFunction<T, N>",
|
|
11947
|
-
"description": "An ExpandTreeFunction<T, N> used to expand each value into a tree.",
|
|
12026
|
+
"description": "- An ExpandTreeFunction<T, N> used to expand each value into a tree.",
|
|
11948
12027
|
"optional": false
|
|
11949
12028
|
}
|
|
11950
12029
|
],
|
|
11951
|
-
"returns": "
|
|
12030
|
+
"returns": "Array of N, where each N is the root node of an expanded tree.",
|
|
11952
12031
|
"tags": [
|
|
11953
12032
|
"tree",
|
|
11954
12033
|
"expand",
|
|
@@ -12144,7 +12223,7 @@
|
|
|
12144
12223
|
"optional": true
|
|
12145
12224
|
}
|
|
12146
12225
|
],
|
|
12147
|
-
"returns": "
|
|
12226
|
+
"returns": "The all nodes in the tree that pass the filter.",
|
|
12148
12227
|
"tags": [
|
|
12149
12228
|
"tree",
|
|
12150
12229
|
"flatten",
|
|
@@ -12266,11 +12345,11 @@
|
|
|
12266
12345
|
{
|
|
12267
12346
|
"name": "config",
|
|
12268
12347
|
"type": "LatLngBoundTupleFunctionConfig",
|
|
12269
|
-
"description": "-
|
|
12348
|
+
"description": "- Optional configuration for point precision.",
|
|
12270
12349
|
"optional": true
|
|
12271
12350
|
}
|
|
12272
12351
|
],
|
|
12273
|
-
"returns": "
|
|
12352
|
+
"returns": "Produces bound tuples from flexible inputs.",
|
|
12274
12353
|
"tags": [
|
|
12275
12354
|
"value",
|
|
12276
12355
|
"lat-lng",
|
|
@@ -12301,11 +12380,11 @@
|
|
|
12301
12380
|
{
|
|
12302
12381
|
"name": "config",
|
|
12303
12382
|
"type": "LatLngBoundFunctionConfig",
|
|
12304
|
-
"description": "-
|
|
12383
|
+
"description": "- Optional configuration for point precision and custom point functions.",
|
|
12305
12384
|
"optional": true
|
|
12306
12385
|
}
|
|
12307
12386
|
],
|
|
12308
|
-
"returns": "
|
|
12387
|
+
"returns": "Produces bounds from flexible inputs.",
|
|
12309
12388
|
"tags": [
|
|
12310
12389
|
"value",
|
|
12311
12390
|
"lat-lng",
|
|
@@ -12338,11 +12417,11 @@
|
|
|
12338
12417
|
{
|
|
12339
12418
|
"name": "bound",
|
|
12340
12419
|
"type": "LatLngBound",
|
|
12341
|
-
"description": "-
|
|
12420
|
+
"description": "- The reference bound to check containment against.",
|
|
12342
12421
|
"optional": false
|
|
12343
12422
|
}
|
|
12344
12423
|
],
|
|
12345
|
-
"returns": "
|
|
12424
|
+
"returns": "Returns `true` if the input is within the reference bound.",
|
|
12346
12425
|
"tags": [
|
|
12347
12426
|
"value",
|
|
12348
12427
|
"lat-lng",
|
|
@@ -12376,11 +12455,11 @@
|
|
|
12376
12455
|
{
|
|
12377
12456
|
"name": "bound",
|
|
12378
12457
|
"type": "LatLngBound",
|
|
12379
|
-
"description": "-
|
|
12458
|
+
"description": "- The reference bound to check overlap against.",
|
|
12380
12459
|
"optional": false
|
|
12381
12460
|
}
|
|
12382
12461
|
],
|
|
12383
|
-
"returns": "
|
|
12462
|
+
"returns": "Returns `true` if the input overlaps the reference bound.",
|
|
12384
12463
|
"tags": [
|
|
12385
12464
|
"value",
|
|
12386
12465
|
"lat-lng",
|
|
@@ -12417,7 +12496,7 @@
|
|
|
12417
12496
|
"optional": false
|
|
12418
12497
|
}
|
|
12419
12498
|
],
|
|
12420
|
-
"returns": "
|
|
12499
|
+
"returns": "The fully constructed object of type T.",
|
|
12421
12500
|
"tags": [
|
|
12422
12501
|
"build",
|
|
12423
12502
|
"builder",
|
|
@@ -12442,11 +12521,11 @@
|
|
|
12442
12521
|
{
|
|
12443
12522
|
"name": "compare",
|
|
12444
12523
|
"type": "EqualityComparatorFunction<T>",
|
|
12445
|
-
"description": "-
|
|
12524
|
+
"description": "- The comparator to wrap.",
|
|
12446
12525
|
"optional": false
|
|
12447
12526
|
}
|
|
12448
12527
|
],
|
|
12449
|
-
"returns": "
|
|
12528
|
+
"returns": "A new comparator that handles nullish values safely before delegating to the wrapped comparator.",
|
|
12450
12529
|
"tags": [
|
|
12451
12530
|
"equal",
|
|
12452
12531
|
"equality",
|
|
@@ -12477,23 +12556,23 @@
|
|
|
12477
12556
|
{
|
|
12478
12557
|
"name": "a",
|
|
12479
12558
|
"type": "Maybe<T>",
|
|
12480
|
-
"description": "-
|
|
12559
|
+
"description": "- First value to compare.",
|
|
12481
12560
|
"optional": false
|
|
12482
12561
|
},
|
|
12483
12562
|
{
|
|
12484
12563
|
"name": "b",
|
|
12485
12564
|
"type": "Maybe<T>",
|
|
12486
|
-
"description": "-
|
|
12565
|
+
"description": "- Second value to compare.",
|
|
12487
12566
|
"optional": false
|
|
12488
12567
|
},
|
|
12489
12568
|
{
|
|
12490
12569
|
"name": "compare",
|
|
12491
12570
|
"type": "EqualityComparatorFunction<T>",
|
|
12492
|
-
"description": "-
|
|
12571
|
+
"description": "- The equality comparator for non-nullish values.",
|
|
12493
12572
|
"optional": false
|
|
12494
12573
|
}
|
|
12495
12574
|
],
|
|
12496
|
-
"returns": "`true` if the values are considered equal",
|
|
12575
|
+
"returns": "`true` if the values are considered equal.",
|
|
12497
12576
|
"tags": [
|
|
12498
12577
|
"equal",
|
|
12499
12578
|
"equality",
|
|
@@ -12521,17 +12600,17 @@
|
|
|
12521
12600
|
{
|
|
12522
12601
|
"name": "readValues",
|
|
12523
12602
|
"type": "ReadValueFunction<I, V>",
|
|
12524
|
-
"description": "-
|
|
12603
|
+
"description": "- Extracts the comparable value from each item.",
|
|
12525
12604
|
"optional": false
|
|
12526
12605
|
},
|
|
12527
12606
|
{
|
|
12528
12607
|
"name": "equalityComparator",
|
|
12529
12608
|
"type": "EqualityComparatorFunction<V>",
|
|
12530
|
-
"description": "-
|
|
12609
|
+
"description": "- Compares the extracted values for equality.",
|
|
12531
12610
|
"optional": false
|
|
12532
12611
|
}
|
|
12533
12612
|
],
|
|
12534
|
-
"returns": "
|
|
12613
|
+
"returns": "Compares two items by their extracted values.",
|
|
12535
12614
|
"tags": [
|
|
12536
12615
|
"value",
|
|
12537
12616
|
"comparator",
|
|
@@ -12563,11 +12642,11 @@
|
|
|
12563
12642
|
{
|
|
12564
12643
|
"name": "readValues",
|
|
12565
12644
|
"type": "ReadValueFunction<I, V>",
|
|
12566
|
-
"description": "-
|
|
12645
|
+
"description": "- Extracts the comparable value from each item.",
|
|
12567
12646
|
"optional": false
|
|
12568
12647
|
}
|
|
12569
12648
|
],
|
|
12570
|
-
"returns": "
|
|
12649
|
+
"returns": "A factory function that accepts an equality comparator and produces a comparison function.",
|
|
12571
12650
|
"tags": [
|
|
12572
12651
|
"value",
|
|
12573
12652
|
"comparator",
|
|
@@ -12601,11 +12680,11 @@
|
|
|
12601
12680
|
{
|
|
12602
12681
|
"name": "decision",
|
|
12603
12682
|
"type": "boolean",
|
|
12604
|
-
"description": "-
|
|
12683
|
+
"description": "- The constant boolean value to return.",
|
|
12605
12684
|
"optional": false
|
|
12606
12685
|
}
|
|
12607
12686
|
],
|
|
12608
|
-
"returns": "
|
|
12687
|
+
"returns": "A decision function that always returns the given boolean.",
|
|
12609
12688
|
"tags": [
|
|
12610
12689
|
"decision",
|
|
12611
12690
|
"boolean",
|
|
@@ -12635,17 +12714,17 @@
|
|
|
12635
12714
|
{
|
|
12636
12715
|
"name": "valueOrFunction",
|
|
12637
12716
|
"type": "Maybe<boolean | DecisionFunction<T>>",
|
|
12638
|
-
"description": "-
|
|
12717
|
+
"description": "- Boolean constant, {@link DecisionFunction }, or undefined to use the default.",
|
|
12639
12718
|
"optional": false
|
|
12640
12719
|
},
|
|
12641
12720
|
{
|
|
12642
12721
|
"name": "defaultIfUndefined",
|
|
12643
12722
|
"type": "boolean",
|
|
12644
|
-
"description": "-
|
|
12723
|
+
"description": "- Fallback boolean when the input is nullish (defaults to true)",
|
|
12645
12724
|
"optional": true
|
|
12646
12725
|
}
|
|
12647
12726
|
],
|
|
12648
|
-
"returns": "
|
|
12727
|
+
"returns": "A {@link DecisionFunction } derived from the input.",
|
|
12649
12728
|
"tags": [
|
|
12650
12729
|
"decision",
|
|
12651
12730
|
"normalize",
|
|
@@ -12714,17 +12793,17 @@
|
|
|
12714
12793
|
{
|
|
12715
12794
|
"name": "contextValue",
|
|
12716
12795
|
"type": "T",
|
|
12717
|
-
"description": "-
|
|
12796
|
+
"description": "- The reference value to compare against.",
|
|
12718
12797
|
"optional": false
|
|
12719
12798
|
},
|
|
12720
12799
|
{
|
|
12721
12800
|
"name": "fn",
|
|
12722
12801
|
"type": "EqualityComparatorFunction<T>",
|
|
12723
|
-
"description": "-
|
|
12802
|
+
"description": "- The equality comparator.",
|
|
12724
12803
|
"optional": false
|
|
12725
12804
|
}
|
|
12726
12805
|
],
|
|
12727
|
-
"returns": "
|
|
12806
|
+
"returns": "Checks whether a given value equals the captured reference.",
|
|
12728
12807
|
"tags": [
|
|
12729
12808
|
"equal",
|
|
12730
12809
|
"equality",
|
|
@@ -12754,17 +12833,17 @@
|
|
|
12754
12833
|
{
|
|
12755
12834
|
"name": "contextValue",
|
|
12756
12835
|
"type": "T",
|
|
12757
|
-
"description": "-
|
|
12836
|
+
"description": "- The reference value to compare against.",
|
|
12758
12837
|
"optional": false
|
|
12759
12838
|
},
|
|
12760
12839
|
{
|
|
12761
12840
|
"name": "fn",
|
|
12762
12841
|
"type": "EqualityComparatorFunction<T>",
|
|
12763
|
-
"description": "-
|
|
12842
|
+
"description": "- The equality comparator.",
|
|
12764
12843
|
"optional": false
|
|
12765
12844
|
}
|
|
12766
12845
|
],
|
|
12767
|
-
"returns": "
|
|
12846
|
+
"returns": "Checks whether all input values equal the captured reference.",
|
|
12768
12847
|
"tags": [
|
|
12769
12848
|
"equal",
|
|
12770
12849
|
"equality",
|
|
@@ -12796,17 +12875,17 @@
|
|
|
12796
12875
|
{
|
|
12797
12876
|
"name": "values",
|
|
12798
12877
|
"type": "IterableOrValue<T>",
|
|
12799
|
-
"description": "-
|
|
12878
|
+
"description": "- The values to compare.",
|
|
12800
12879
|
"optional": false
|
|
12801
12880
|
},
|
|
12802
12881
|
{
|
|
12803
12882
|
"name": "fn",
|
|
12804
12883
|
"type": "EqualityComparatorFunction<T>",
|
|
12805
|
-
"description": "-
|
|
12884
|
+
"description": "- The equality comparator.",
|
|
12806
12885
|
"optional": false
|
|
12807
12886
|
}
|
|
12808
12887
|
],
|
|
12809
|
-
"returns": "`true` if all values are equal to each other, or if fewer than two values are provided",
|
|
12888
|
+
"returns": "`true` if all values are equal to each other, or if fewer than two values are provided.",
|
|
12810
12889
|
"tags": [
|
|
12811
12890
|
"equal",
|
|
12812
12891
|
"equality",
|
|
@@ -12835,7 +12914,7 @@
|
|
|
12835
12914
|
"signature": "sortAscendingIndexNumberRefFunction(): SortCompareFunction<T>",
|
|
12836
12915
|
"description": "Creates a SortCompareFunction that sorts IndexRef values in ascending order by their index number.",
|
|
12837
12916
|
"params": [],
|
|
12838
|
-
"returns": "
|
|
12917
|
+
"returns": "A compare function suitable for Array.sort()",
|
|
12839
12918
|
"tags": [
|
|
12840
12919
|
"value",
|
|
12841
12920
|
"index",
|
|
@@ -12866,11 +12945,11 @@
|
|
|
12866
12945
|
{
|
|
12867
12946
|
"name": "readIndex",
|
|
12868
12947
|
"type": "ReadMaybeIndexFunction<T>",
|
|
12869
|
-
"description": "-
|
|
12948
|
+
"description": "- Reads an item's index, returning null/undefined for unindexed items.",
|
|
12870
12949
|
"optional": false
|
|
12871
12950
|
}
|
|
12872
12951
|
],
|
|
12873
|
-
"returns": "
|
|
12952
|
+
"returns": "Groups items by their index state.",
|
|
12874
12953
|
"tags": [
|
|
12875
12954
|
"value",
|
|
12876
12955
|
"index",
|
|
@@ -12900,11 +12979,11 @@
|
|
|
12900
12979
|
{
|
|
12901
12980
|
"name": "readIndex",
|
|
12902
12981
|
"type": "ReadIndexFunction<T>",
|
|
12903
|
-
"description": "-
|
|
12982
|
+
"description": "- Extracts the index number from each item.",
|
|
12904
12983
|
"optional": false
|
|
12905
12984
|
}
|
|
12906
12985
|
],
|
|
12907
|
-
"returns": "
|
|
12986
|
+
"returns": "A compare function suitable for Array.sort()",
|
|
12908
12987
|
"tags": [
|
|
12909
12988
|
"value",
|
|
12910
12989
|
"index",
|
|
@@ -12934,17 +13013,17 @@
|
|
|
12934
13013
|
{
|
|
12935
13014
|
"name": "readIndex",
|
|
12936
13015
|
"type": "ReadIndexFunction<T>",
|
|
12937
|
-
"description": "-
|
|
13016
|
+
"description": "- Extracts the index number from each item.",
|
|
12938
13017
|
"optional": false
|
|
12939
13018
|
},
|
|
12940
13019
|
{
|
|
12941
13020
|
"name": "nextIndex",
|
|
12942
13021
|
"type": "(value: T) => IndexNumber",
|
|
12943
|
-
"description": "-
|
|
13022
|
+
"description": "- Optional custom function to compute the next index from the max item; defaults to max + 1.",
|
|
12944
13023
|
"optional": true
|
|
12945
13024
|
}
|
|
12946
13025
|
],
|
|
12947
|
-
"returns": "
|
|
13026
|
+
"returns": "Computes the next free index for a given array.",
|
|
12948
13027
|
"tags": [
|
|
12949
13028
|
"value",
|
|
12950
13029
|
"index",
|
|
@@ -12975,17 +13054,17 @@
|
|
|
12975
13054
|
{
|
|
12976
13055
|
"name": "readIndex",
|
|
12977
13056
|
"type": "ReadIndexFunction<T>",
|
|
12978
|
-
"description": "-
|
|
13057
|
+
"description": "- Extracts the index number from each item.",
|
|
12979
13058
|
"optional": false
|
|
12980
13059
|
},
|
|
12981
13060
|
{
|
|
12982
13061
|
"name": "nextIndex",
|
|
12983
13062
|
"type": "(value: T) => IndexNumber",
|
|
12984
|
-
"description": "-
|
|
13063
|
+
"description": "- Optional custom function to compute the next index from the last item; defaults to last + 1.",
|
|
12985
13064
|
"optional": true
|
|
12986
13065
|
}
|
|
12987
13066
|
],
|
|
12988
|
-
"returns": "
|
|
13067
|
+
"returns": "Computes the next free index from sorted arrays.",
|
|
12989
13068
|
"tags": [
|
|
12990
13069
|
"value",
|
|
12991
13070
|
"index",
|
|
@@ -13017,11 +13096,11 @@
|
|
|
13017
13096
|
{
|
|
13018
13097
|
"name": "readIndex",
|
|
13019
13098
|
"type": "ReadIndexFunction<T>",
|
|
13020
|
-
"description": "-
|
|
13099
|
+
"description": "- Extracts the index number from each item.",
|
|
13021
13100
|
"optional": false
|
|
13022
13101
|
}
|
|
13023
13102
|
],
|
|
13024
|
-
"returns": "
|
|
13103
|
+
"returns": "The min/max indexes, or null for empty input.",
|
|
13025
13104
|
"tags": [
|
|
13026
13105
|
"value",
|
|
13027
13106
|
"index",
|
|
@@ -13052,11 +13131,11 @@
|
|
|
13052
13131
|
{
|
|
13053
13132
|
"name": "readIndex",
|
|
13054
13133
|
"type": "ReadIndexFunction<T>",
|
|
13055
|
-
"description": "-
|
|
13134
|
+
"description": "- Extracts the index number from each item.",
|
|
13056
13135
|
"optional": false
|
|
13057
13136
|
}
|
|
13058
13137
|
],
|
|
13059
|
-
"returns": "
|
|
13138
|
+
"returns": "The min/max items, or null for empty input.",
|
|
13060
13139
|
"tags": [
|
|
13061
13140
|
"value",
|
|
13062
13141
|
"index",
|
|
@@ -13086,11 +13165,11 @@
|
|
|
13086
13165
|
{
|
|
13087
13166
|
"name": "items",
|
|
13088
13167
|
"type": "Iterable<T>",
|
|
13089
|
-
"description": "-
|
|
13168
|
+
"description": "- The available match options; must not be empty.",
|
|
13090
13169
|
"optional": false
|
|
13091
13170
|
}
|
|
13092
13171
|
],
|
|
13093
|
-
"returns": "
|
|
13172
|
+
"returns": "Finds the best match for any input index.",
|
|
13094
13173
|
"tags": [
|
|
13095
13174
|
"value",
|
|
13096
13175
|
"index",
|
|
@@ -13121,11 +13200,11 @@
|
|
|
13121
13200
|
{
|
|
13122
13201
|
"name": "readIndexRange",
|
|
13123
13202
|
"type": "ReadIndexRangeFunction<T>",
|
|
13124
|
-
"description": "-
|
|
13203
|
+
"description": "- Extracts the IndexRange from each item.",
|
|
13125
13204
|
"optional": false
|
|
13126
13205
|
}
|
|
13127
13206
|
],
|
|
13128
|
-
"returns": "
|
|
13207
|
+
"returns": "A compare function suitable for Array.sort()",
|
|
13129
13208
|
"tags": [
|
|
13130
13209
|
"value",
|
|
13131
13210
|
"index-range",
|
|
@@ -13157,11 +13236,11 @@
|
|
|
13157
13236
|
{
|
|
13158
13237
|
"name": "reader",
|
|
13159
13238
|
"type": "ReadIndexRangeFunction<T>",
|
|
13160
|
-
"description": "-
|
|
13239
|
+
"description": "- Reads the IndexRange from the input value.",
|
|
13161
13240
|
"optional": false
|
|
13162
13241
|
}
|
|
13163
13242
|
],
|
|
13164
|
-
"returns": "
|
|
13243
|
+
"returns": "A factory that creates IndexRangeReaderPair instances.",
|
|
13165
13244
|
"tags": [
|
|
13166
13245
|
"value",
|
|
13167
13246
|
"index-range",
|
|
@@ -13189,11 +13268,11 @@
|
|
|
13189
13268
|
{
|
|
13190
13269
|
"name": "input",
|
|
13191
13270
|
"type": "IndexRange",
|
|
13192
|
-
"description": "-
|
|
13271
|
+
"description": "- The range to clamp to.",
|
|
13193
13272
|
"optional": false
|
|
13194
13273
|
}
|
|
13195
13274
|
],
|
|
13196
|
-
"returns": "
|
|
13275
|
+
"returns": "Clamps any index to the range.",
|
|
13197
13276
|
"tags": [
|
|
13198
13277
|
"value",
|
|
13199
13278
|
"index",
|
|
@@ -13223,17 +13302,17 @@
|
|
|
13223
13302
|
{
|
|
13224
13303
|
"name": "input",
|
|
13225
13304
|
"type": "IndexRange",
|
|
13226
|
-
"description": "-
|
|
13305
|
+
"description": "- The index range to wrap within.",
|
|
13227
13306
|
"optional": false
|
|
13228
13307
|
},
|
|
13229
13308
|
{
|
|
13230
13309
|
"name": "fencePosts",
|
|
13231
13310
|
"type": "boolean",
|
|
13232
|
-
"description": "-
|
|
13311
|
+
"description": "- Whether to use fencepost semantics (maxIndex is exclusive); defaults to true.",
|
|
13233
13312
|
"optional": true
|
|
13234
13313
|
}
|
|
13235
13314
|
],
|
|
13236
|
-
"returns": "
|
|
13315
|
+
"returns": "Wraps any index into the range.",
|
|
13237
13316
|
"tags": [
|
|
13238
13317
|
"value",
|
|
13239
13318
|
"index",
|
|
@@ -13303,11 +13382,11 @@
|
|
|
13303
13382
|
{
|
|
13304
13383
|
"name": "input",
|
|
13305
13384
|
"type": "IndexRangeFunctionInput",
|
|
13306
|
-
"description": "-
|
|
13385
|
+
"description": "- The range or range config to check against.",
|
|
13307
13386
|
"optional": false
|
|
13308
13387
|
}
|
|
13309
13388
|
],
|
|
13310
|
-
"returns": "
|
|
13389
|
+
"returns": "A predicate function for index numbers.",
|
|
13311
13390
|
"tags": [
|
|
13312
13391
|
"value",
|
|
13313
13392
|
"index",
|
|
@@ -13336,11 +13415,11 @@
|
|
|
13336
13415
|
{
|
|
13337
13416
|
"name": "input",
|
|
13338
13417
|
"type": "IndexRangeFunctionInput",
|
|
13339
|
-
"description": "-
|
|
13418
|
+
"description": "- The range or range config to bind.",
|
|
13340
13419
|
"optional": false
|
|
13341
13420
|
}
|
|
13342
13421
|
],
|
|
13343
|
-
"returns": "
|
|
13422
|
+
"returns": "A predicate that tests index numbers against the bound range.",
|
|
13344
13423
|
"tags": [
|
|
13345
13424
|
"value",
|
|
13346
13425
|
"index",
|
|
@@ -13372,11 +13451,11 @@
|
|
|
13372
13451
|
{
|
|
13373
13452
|
"name": "input",
|
|
13374
13453
|
"type": "IndexRangeFunctionInput",
|
|
13375
|
-
"description": "-
|
|
13454
|
+
"description": "- The bounding range or range config to bind.",
|
|
13376
13455
|
"optional": false
|
|
13377
13456
|
}
|
|
13378
13457
|
],
|
|
13379
|
-
"returns": "
|
|
13458
|
+
"returns": "A predicate that tests whether index ranges are fully contained.",
|
|
13380
13459
|
"tags": [
|
|
13381
13460
|
"value",
|
|
13382
13461
|
"index-range",
|
|
@@ -13409,11 +13488,11 @@
|
|
|
13409
13488
|
{
|
|
13410
13489
|
"name": "input",
|
|
13411
13490
|
"type": "IndexRangeFunctionInput",
|
|
13412
|
-
"description": "-
|
|
13491
|
+
"description": "- The reference range or range config to bind.",
|
|
13413
13492
|
"optional": false
|
|
13414
13493
|
}
|
|
13415
13494
|
],
|
|
13416
|
-
"returns": "
|
|
13495
|
+
"returns": "A predicate that tests for overlap with the bound range.",
|
|
13417
13496
|
"tags": [
|
|
13418
13497
|
"value",
|
|
13419
13498
|
"index-range",
|
|
@@ -13445,11 +13524,11 @@
|
|
|
13445
13524
|
{
|
|
13446
13525
|
"name": "config",
|
|
13447
13526
|
"type": "StepsFromIndexFunctionConfig",
|
|
13448
|
-
"description": "-
|
|
13527
|
+
"description": "- Stepping behavior configuration.",
|
|
13449
13528
|
"optional": false
|
|
13450
13529
|
}
|
|
13451
13530
|
],
|
|
13452
|
-
"returns": "
|
|
13531
|
+
"returns": "Computes the stepped index.",
|
|
13453
13532
|
"tags": [
|
|
13454
13533
|
"value",
|
|
13455
13534
|
"index",
|
|
@@ -13481,11 +13560,11 @@
|
|
|
13481
13560
|
{
|
|
13482
13561
|
"name": "mapFunction",
|
|
13483
13562
|
"type": "MapFunction<I, O>",
|
|
13484
|
-
"description": "-
|
|
13563
|
+
"description": "- Function to apply only when the input is defined.",
|
|
13485
13564
|
"optional": false
|
|
13486
13565
|
}
|
|
13487
13566
|
],
|
|
13488
|
-
"returns": "
|
|
13567
|
+
"returns": "A new function that short-circuits on null/undefined inputs.",
|
|
13489
13568
|
"tags": [
|
|
13490
13569
|
"map",
|
|
13491
13570
|
"transform",
|
|
@@ -13516,11 +13595,11 @@
|
|
|
13516
13595
|
{
|
|
13517
13596
|
"name": "mapFunction",
|
|
13518
13597
|
"type": "MapFunction<I, O>",
|
|
13519
|
-
"description": "-
|
|
13598
|
+
"description": "- Per-element transformation.",
|
|
13520
13599
|
"optional": false
|
|
13521
13600
|
}
|
|
13522
13601
|
],
|
|
13523
|
-
"returns": "
|
|
13602
|
+
"returns": "Maps entire arrays.",
|
|
13524
13603
|
"tags": [
|
|
13525
13604
|
"map",
|
|
13526
13605
|
"transform",
|
|
@@ -13572,7 +13651,7 @@
|
|
|
13572
13651
|
"signature": "mapIdentityFunction(): MapFunction<T, T>",
|
|
13573
13652
|
"description": "Returns the shared {@link MAP_IDENTITY} function cast to the requested type, useful for providing a typed no-op transformation.",
|
|
13574
13653
|
"params": [],
|
|
13575
|
-
"returns": "
|
|
13654
|
+
"returns": "The singleton identity function typed as `MapFunction<T, T>`",
|
|
13576
13655
|
"tags": [
|
|
13577
13656
|
"map",
|
|
13578
13657
|
"identity",
|
|
@@ -13600,11 +13679,11 @@
|
|
|
13600
13679
|
{
|
|
13601
13680
|
"name": "fn",
|
|
13602
13681
|
"type": "unknown",
|
|
13603
|
-
"description": "-
|
|
13682
|
+
"description": "- The function to check.",
|
|
13604
13683
|
"optional": false
|
|
13605
13684
|
}
|
|
13606
13685
|
],
|
|
13607
|
-
"returns": "`true` if the function is the identity singleton",
|
|
13686
|
+
"returns": "`true` if the function is the identity singleton.",
|
|
13608
13687
|
"tags": [
|
|
13609
13688
|
"map",
|
|
13610
13689
|
"identity",
|
|
@@ -13633,11 +13712,11 @@
|
|
|
13633
13712
|
{
|
|
13634
13713
|
"name": "input",
|
|
13635
13714
|
"type": "ArrayOrValue<Maybe<MapSameFunction<I>>>",
|
|
13636
|
-
"description": "-
|
|
13715
|
+
"description": "- One or more optional same-type map functions to chain.",
|
|
13637
13716
|
"optional": false
|
|
13638
13717
|
}
|
|
13639
13718
|
],
|
|
13640
|
-
"returns": "
|
|
13719
|
+
"returns": "A single composed function that runs all provided functions in order.",
|
|
13641
13720
|
"tags": [
|
|
13642
13721
|
"map",
|
|
13643
13722
|
"chain",
|
|
@@ -13714,7 +13793,7 @@
|
|
|
13714
13793
|
{
|
|
13715
13794
|
"name": "value",
|
|
13716
13795
|
"type": "Maybe<T>",
|
|
13717
|
-
"description": "-
|
|
13796
|
+
"description": "- The value to check.",
|
|
13718
13797
|
"optional": false
|
|
13719
13798
|
}
|
|
13720
13799
|
],
|
|
@@ -13750,11 +13829,11 @@
|
|
|
13750
13829
|
{
|
|
13751
13830
|
"name": "value",
|
|
13752
13831
|
"type": "Maybe<T>",
|
|
13753
|
-
"description": "-
|
|
13832
|
+
"description": "- The value to check.",
|
|
13754
13833
|
"optional": false
|
|
13755
13834
|
}
|
|
13756
13835
|
],
|
|
13757
|
-
"returns": "`true` if the value is non-nullish and not empty",
|
|
13836
|
+
"returns": "`true` if the value is non-nullish and not empty.",
|
|
13758
13837
|
"tags": [
|
|
13759
13838
|
"maybe",
|
|
13760
13839
|
"empty",
|
|
@@ -13786,11 +13865,11 @@
|
|
|
13786
13865
|
{
|
|
13787
13866
|
"name": "value",
|
|
13788
13867
|
"type": "Maybe<T>",
|
|
13789
|
-
"description": "-
|
|
13868
|
+
"description": "- The value to check.",
|
|
13790
13869
|
"optional": false
|
|
13791
13870
|
}
|
|
13792
13871
|
],
|
|
13793
|
-
"returns": "`true` if the value is non-nullish, non-empty, and not an empty object",
|
|
13872
|
+
"returns": "`true` if the value is non-nullish, non-empty, and not an empty object.",
|
|
13794
13873
|
"tags": [
|
|
13795
13874
|
"maybe",
|
|
13796
13875
|
"empty",
|
|
@@ -13823,11 +13902,11 @@
|
|
|
13823
13902
|
{
|
|
13824
13903
|
"name": "value",
|
|
13825
13904
|
"type": "Maybe<MaybeNot | '' | T>",
|
|
13826
|
-
"description": "-
|
|
13905
|
+
"description": "- The value to check.",
|
|
13827
13906
|
"optional": false
|
|
13828
13907
|
}
|
|
13829
13908
|
],
|
|
13830
|
-
"returns": "`true` if the value is not nullish and not an empty string",
|
|
13909
|
+
"returns": "`true` if the value is not nullish and not an empty string.",
|
|
13831
13910
|
"tags": [
|
|
13832
13911
|
"maybe",
|
|
13833
13912
|
"string",
|
|
@@ -13860,7 +13939,7 @@
|
|
|
13860
13939
|
{
|
|
13861
13940
|
"name": "value",
|
|
13862
13941
|
"type": "Maybe<T>",
|
|
13863
|
-
"description": "-
|
|
13942
|
+
"description": "- The value to check.",
|
|
13864
13943
|
"optional": false
|
|
13865
13944
|
}
|
|
13866
13945
|
],
|
|
@@ -13895,7 +13974,7 @@
|
|
|
13895
13974
|
{
|
|
13896
13975
|
"name": "value",
|
|
13897
13976
|
"type": "Maybe<T>",
|
|
13898
|
-
"description": "-
|
|
13977
|
+
"description": "- The value to check.",
|
|
13899
13978
|
"optional": false
|
|
13900
13979
|
}
|
|
13901
13980
|
],
|
|
@@ -13930,7 +14009,7 @@
|
|
|
13930
14009
|
{
|
|
13931
14010
|
"name": "value",
|
|
13932
14011
|
"type": "Maybe<T>",
|
|
13933
|
-
"description": "-
|
|
14012
|
+
"description": "- The value to check.",
|
|
13934
14013
|
"optional": false
|
|
13935
14014
|
}
|
|
13936
14015
|
],
|
|
@@ -13966,17 +14045,17 @@
|
|
|
13966
14045
|
{
|
|
13967
14046
|
"name": "a",
|
|
13968
14047
|
"type": "Maybe<T>",
|
|
13969
|
-
"description": "-
|
|
14048
|
+
"description": "- First value.",
|
|
13970
14049
|
"optional": false
|
|
13971
14050
|
},
|
|
13972
14051
|
{
|
|
13973
14052
|
"name": "b",
|
|
13974
14053
|
"type": "Maybe<T>",
|
|
13975
|
-
"description": "-
|
|
14054
|
+
"description": "- Second value.",
|
|
13976
14055
|
"optional": false
|
|
13977
14056
|
}
|
|
13978
14057
|
],
|
|
13979
|
-
"returns": "`true` if both values are non-nullish and strictly equal",
|
|
14058
|
+
"returns": "`true` if both values are non-nullish and strictly equal.",
|
|
13980
14059
|
"tags": [
|
|
13981
14060
|
"maybe",
|
|
13982
14061
|
"equal",
|
|
@@ -14008,17 +14087,17 @@
|
|
|
14008
14087
|
{
|
|
14009
14088
|
"name": "a",
|
|
14010
14089
|
"type": "Maybe<T>",
|
|
14011
|
-
"description": "-
|
|
14090
|
+
"description": "- First value.",
|
|
14012
14091
|
"optional": false
|
|
14013
14092
|
},
|
|
14014
14093
|
{
|
|
14015
14094
|
"name": "b",
|
|
14016
14095
|
"type": "Maybe<T>",
|
|
14017
|
-
"description": "-
|
|
14096
|
+
"description": "- Second value.",
|
|
14018
14097
|
"optional": false
|
|
14019
14098
|
}
|
|
14020
14099
|
],
|
|
14021
|
-
"returns": "`true` if both are nullish or both are the same value",
|
|
14100
|
+
"returns": "`true` if both are nullish or both are the same value.",
|
|
14022
14101
|
"tags": [
|
|
14023
14102
|
"maybe",
|
|
14024
14103
|
"equal",
|
|
@@ -14050,13 +14129,13 @@
|
|
|
14050
14129
|
{
|
|
14051
14130
|
"name": "a",
|
|
14052
14131
|
"type": "Maybe<T>",
|
|
14053
|
-
"description": "-
|
|
14132
|
+
"description": "- The current value.",
|
|
14054
14133
|
"optional": false
|
|
14055
14134
|
},
|
|
14056
14135
|
{
|
|
14057
14136
|
"name": "b",
|
|
14058
14137
|
"type": "Maybe<T>",
|
|
14059
|
-
"description": "-
|
|
14138
|
+
"description": "- The update value.",
|
|
14060
14139
|
"optional": false
|
|
14061
14140
|
}
|
|
14062
14141
|
],
|
|
@@ -14085,17 +14164,17 @@
|
|
|
14085
14164
|
{
|
|
14086
14165
|
"name": "key",
|
|
14087
14166
|
"type": "string",
|
|
14088
|
-
"description": "-
|
|
14167
|
+
"description": "- Unique identifier for the modifier.",
|
|
14089
14168
|
"optional": false
|
|
14090
14169
|
},
|
|
14091
14170
|
{
|
|
14092
14171
|
"name": "modify",
|
|
14093
14172
|
"type": "ModifierFunction<T>",
|
|
14094
|
-
"description": "-
|
|
14173
|
+
"description": "- Function that mutates the target value.",
|
|
14095
14174
|
"optional": false
|
|
14096
14175
|
}
|
|
14097
14176
|
],
|
|
14098
|
-
"returns": "
|
|
14177
|
+
"returns": "A new {@link Modifier } pairing the key with the modify function.",
|
|
14099
14178
|
"tags": [
|
|
14100
14179
|
"modifier",
|
|
14101
14180
|
"mutate",
|
|
@@ -14123,11 +14202,11 @@
|
|
|
14123
14202
|
{
|
|
14124
14203
|
"name": "map",
|
|
14125
14204
|
"type": "Maybe<ModifierMap<T>>",
|
|
14126
|
-
"description": "-
|
|
14205
|
+
"description": "- The modifier map to convert.",
|
|
14127
14206
|
"optional": false
|
|
14128
14207
|
}
|
|
14129
14208
|
],
|
|
14130
|
-
"returns": "
|
|
14209
|
+
"returns": "A single modifier function that applies all mapped modifiers, or {@link NOOP_MODIFIER } if empty.",
|
|
14131
14210
|
"tags": [
|
|
14132
14211
|
"modifier",
|
|
14133
14212
|
"map",
|
|
@@ -14157,11 +14236,11 @@
|
|
|
14157
14236
|
{
|
|
14158
14237
|
"name": "map",
|
|
14159
14238
|
"type": "Maybe<ModifierMap<T>>",
|
|
14160
|
-
"description": "-
|
|
14239
|
+
"description": "- The modifier map to convert.",
|
|
14161
14240
|
"optional": false
|
|
14162
14241
|
}
|
|
14163
14242
|
],
|
|
14164
|
-
"returns": "
|
|
14243
|
+
"returns": "A composed modifier function, or `undefined` if no map is provided.",
|
|
14165
14244
|
"tags": [
|
|
14166
14245
|
"modifier",
|
|
14167
14246
|
"map",
|
|
@@ -14192,11 +14271,11 @@
|
|
|
14192
14271
|
{
|
|
14193
14272
|
"name": "config",
|
|
14194
14273
|
"type": "LatLngTupleFunctionConfig",
|
|
14195
|
-
"description": "-
|
|
14274
|
+
"description": "- Optional configuration for precision and wrapping behavior.",
|
|
14196
14275
|
"optional": true
|
|
14197
14276
|
}
|
|
14198
14277
|
],
|
|
14199
|
-
"returns": "
|
|
14278
|
+
"returns": "Produces lat/lng tuples from flexible inputs.",
|
|
14200
14279
|
"tags": [
|
|
14201
14280
|
"value",
|
|
14202
14281
|
"lat-lng",
|
|
@@ -14227,17 +14306,17 @@
|
|
|
14227
14306
|
{
|
|
14228
14307
|
"name": "precision",
|
|
14229
14308
|
"type": "LatLngPrecision",
|
|
14230
|
-
"description": "-
|
|
14309
|
+
"description": "- Number of decimal places to retain.",
|
|
14231
14310
|
"optional": false
|
|
14232
14311
|
},
|
|
14233
14312
|
{
|
|
14234
14313
|
"name": "precisionRounding",
|
|
14235
14314
|
"type": "RoundToPrecisionFunctionType",
|
|
14236
|
-
"description": "-
|
|
14315
|
+
"description": "- Optional rounding strategy (e.g., floor, ceil, round)",
|
|
14237
14316
|
"optional": true
|
|
14238
14317
|
}
|
|
14239
14318
|
],
|
|
14240
|
-
"returns": "
|
|
14319
|
+
"returns": "Rounds points to the given precision.",
|
|
14241
14320
|
"tags": [
|
|
14242
14321
|
"value",
|
|
14243
14322
|
"lat-lng",
|
|
@@ -14269,11 +14348,11 @@
|
|
|
14269
14348
|
{
|
|
14270
14349
|
"name": "config",
|
|
14271
14350
|
"type": "LatLngStringFunctionConfig",
|
|
14272
|
-
"description": "-
|
|
14351
|
+
"description": "- Optional configuration for precision and wrapping behavior.",
|
|
14273
14352
|
"optional": true
|
|
14274
14353
|
}
|
|
14275
14354
|
],
|
|
14276
|
-
"returns": "
|
|
14355
|
+
"returns": "Produces lat/lng strings from flexible inputs.",
|
|
14277
14356
|
"tags": [
|
|
14278
14357
|
"value",
|
|
14279
14358
|
"lat-lng",
|
|
@@ -14304,11 +14383,11 @@
|
|
|
14304
14383
|
{
|
|
14305
14384
|
"name": "config",
|
|
14306
14385
|
"type": "LatLngPointFunctionConfig",
|
|
14307
|
-
"description": "-
|
|
14386
|
+
"description": "- Optional configuration for precision, wrapping, validation, and tuple ordering.",
|
|
14308
14387
|
"optional": true
|
|
14309
14388
|
}
|
|
14310
14389
|
],
|
|
14311
|
-
"returns": "
|
|
14390
|
+
"returns": "Produces points from flexible inputs.",
|
|
14312
14391
|
"tags": [
|
|
14313
14392
|
"value",
|
|
14314
14393
|
"lat-lng",
|
|
@@ -14342,11 +14421,11 @@
|
|
|
14342
14421
|
{
|
|
14343
14422
|
"name": "defaultValue",
|
|
14344
14423
|
"type": "Factory<LatLngPoint>",
|
|
14345
|
-
"description": "-
|
|
14424
|
+
"description": "- Factory for the fallback point; defaults to `defaultLatLngPoint`",
|
|
14346
14425
|
"optional": true
|
|
14347
14426
|
}
|
|
14348
14427
|
],
|
|
14349
|
-
"returns": "
|
|
14428
|
+
"returns": "A validation function.",
|
|
14350
14429
|
"tags": [
|
|
14351
14430
|
"value",
|
|
14352
14431
|
"lat-lng",
|
|
@@ -14379,11 +14458,11 @@
|
|
|
14379
14458
|
{
|
|
14380
14459
|
"name": "config",
|
|
14381
14460
|
"type": "LatLngPointFunctionConfig",
|
|
14382
|
-
"description": "-
|
|
14461
|
+
"description": "- Optional configuration for precision and wrapping behavior.",
|
|
14383
14462
|
"optional": true
|
|
14384
14463
|
}
|
|
14385
14464
|
],
|
|
14386
|
-
"returns": "
|
|
14465
|
+
"returns": "Produces data points from lat/lng references.",
|
|
14387
14466
|
"tags": [
|
|
14388
14467
|
"value",
|
|
14389
14468
|
"lat-lng",
|
|
@@ -14415,11 +14494,11 @@
|
|
|
14415
14494
|
{
|
|
14416
14495
|
"name": "config",
|
|
14417
14496
|
"type": "RandomLatLngFactoryConfig",
|
|
14418
|
-
"description": "-
|
|
14497
|
+
"description": "- Optional bounding box and precision configuration.",
|
|
14419
14498
|
"optional": true
|
|
14420
14499
|
}
|
|
14421
14500
|
],
|
|
14422
|
-
"returns": "
|
|
14501
|
+
"returns": "A factory that produces random points within the bounds.",
|
|
14423
14502
|
"tags": [
|
|
14424
14503
|
"value",
|
|
14425
14504
|
"lat-lng",
|
|
@@ -14449,11 +14528,11 @@
|
|
|
14449
14528
|
{
|
|
14450
14529
|
"name": "config",
|
|
14451
14530
|
"type": "RandomLatLngFromCenterFactoryConfig",
|
|
14452
|
-
"description": "-
|
|
14531
|
+
"description": "- Center point, distances, and optional precision.",
|
|
14453
14532
|
"optional": false
|
|
14454
14533
|
}
|
|
14455
14534
|
],
|
|
14456
|
-
"returns": "
|
|
14535
|
+
"returns": "A factory that produces random points near the center.",
|
|
14457
14536
|
"tags": [
|
|
14458
14537
|
"value",
|
|
14459
14538
|
"lat-lng",
|
|
@@ -14484,11 +14563,11 @@
|
|
|
14484
14563
|
{
|
|
14485
14564
|
"name": "map",
|
|
14486
14565
|
"type": "MapFunction<A, Maybe<I>>",
|
|
14487
|
-
"description": "-
|
|
14566
|
+
"description": "- Transforms the outer input into the type expected by the consumer.",
|
|
14488
14567
|
"optional": false
|
|
14489
14568
|
}
|
|
14490
14569
|
],
|
|
14491
|
-
"returns": "
|
|
14570
|
+
"returns": "A MappedUseFunction that maps then consumes.",
|
|
14492
14571
|
"tags": [
|
|
14493
14572
|
"value",
|
|
14494
14573
|
"use",
|
|
@@ -14519,17 +14598,17 @@
|
|
|
14519
14598
|
{
|
|
14520
14599
|
"name": "mappedUseFn",
|
|
14521
14600
|
"type": "MappedUseFunction<A, B>",
|
|
14522
|
-
"description": "-
|
|
14601
|
+
"description": "- The existing mapped use function to wrap.",
|
|
14523
14602
|
"optional": false
|
|
14524
14603
|
},
|
|
14525
14604
|
{
|
|
14526
14605
|
"name": "map",
|
|
14527
14606
|
"type": "MapFunction<B, Maybe<I>>",
|
|
14528
|
-
"description": "-
|
|
14607
|
+
"description": "- Additional transformation applied to the intermediate value.",
|
|
14529
14608
|
"optional": false
|
|
14530
14609
|
}
|
|
14531
14610
|
],
|
|
14532
|
-
"returns": "
|
|
14611
|
+
"returns": "A new MappedUseFunction with the extra mapping layer.",
|
|
14533
14612
|
"tags": [
|
|
14534
14613
|
"value",
|
|
14535
14614
|
"use",
|
|
@@ -14558,17 +14637,17 @@
|
|
|
14558
14637
|
{
|
|
14559
14638
|
"name": "use",
|
|
14560
14639
|
"type": "UseValue<I, O>",
|
|
14561
|
-
"description": "-
|
|
14640
|
+
"description": "- The consumer function to bind.",
|
|
14562
14641
|
"optional": false
|
|
14563
14642
|
},
|
|
14564
14643
|
{
|
|
14565
14644
|
"name": "defaultValue",
|
|
14566
14645
|
"type": "GetterOrValue<O>",
|
|
14567
|
-
"description": "-
|
|
14646
|
+
"description": "- Fallback when input is null/undefined.",
|
|
14568
14647
|
"optional": true
|
|
14569
14648
|
}
|
|
14570
14649
|
],
|
|
14571
|
-
"returns": "
|
|
14650
|
+
"returns": "A single-argument function that applies the bound consumer.",
|
|
14572
14651
|
"tags": [
|
|
14573
14652
|
"value",
|
|
14574
14653
|
"use",
|
|
@@ -14597,11 +14676,11 @@
|
|
|
14597
14676
|
{
|
|
14598
14677
|
"name": "map",
|
|
14599
14678
|
"type": "MapFunction<A, Maybe<PromiseOrValue<Maybe<I>>>>",
|
|
14600
|
-
"description": "-
|
|
14679
|
+
"description": "- Transforms the outer input, optionally asynchronously, into the type expected by the consumer.",
|
|
14601
14680
|
"optional": false
|
|
14602
14681
|
}
|
|
14603
14682
|
],
|
|
14604
|
-
"returns": "
|
|
14683
|
+
"returns": "A MappedUseAsyncFunction that maps then asynchronously consumes.",
|
|
14605
14684
|
"tags": [
|
|
14606
14685
|
"value",
|
|
14607
14686
|
"use",
|
|
@@ -14632,17 +14711,17 @@
|
|
|
14632
14711
|
{
|
|
14633
14712
|
"name": "mappedUsePromiseFn",
|
|
14634
14713
|
"type": "MappedUseAsyncFunction<A, B>",
|
|
14635
|
-
"description": "-
|
|
14714
|
+
"description": "- The existing async mapped use function to wrap.",
|
|
14636
14715
|
"optional": false
|
|
14637
14716
|
},
|
|
14638
14717
|
{
|
|
14639
14718
|
"name": "map",
|
|
14640
14719
|
"type": "MapFunction<B, Maybe<PromiseOrValue<Maybe<I>>>>",
|
|
14641
|
-
"description": "-
|
|
14720
|
+
"description": "- Additional transformation (sync or async) applied to the intermediate value.",
|
|
14642
14721
|
"optional": false
|
|
14643
14722
|
}
|
|
14644
14723
|
],
|
|
14645
|
-
"returns": "
|
|
14724
|
+
"returns": "A new MappedUseAsyncFunction with the extra mapping layer.",
|
|
14646
14725
|
"tags": [
|
|
14647
14726
|
"value",
|
|
14648
14727
|
"use",
|
|
@@ -14673,11 +14752,11 @@
|
|
|
14673
14752
|
{
|
|
14674
14753
|
"name": "minSize",
|
|
14675
14754
|
"type": "Partial<Vector>",
|
|
14676
|
-
"description": "-
|
|
14755
|
+
"description": "- The minimum dimensions to enforce.",
|
|
14677
14756
|
"optional": false
|
|
14678
14757
|
}
|
|
14679
14758
|
],
|
|
14680
|
-
"returns": "
|
|
14759
|
+
"returns": "A resize function that clamps each axis to the specified minimum.",
|
|
14681
14760
|
"tags": [
|
|
14682
14761
|
"value",
|
|
14683
14762
|
"vector",
|