@guillaume-docquier/tools-ts 2.3.0 → 3.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/Range.d.ts +20 -6
- package/dist/Range.js +29 -6
- package/dist/Range.js.map +1 -1
- package/package.json +1 -1
package/dist/Range.d.ts
CHANGED
|
@@ -1,12 +1,12 @@
|
|
|
1
1
|
import { Result } from "./Result.js";
|
|
2
2
|
/**
|
|
3
3
|
* A finite numeric interval with an inclusive minimum and either an inclusive or exclusive maximum.
|
|
4
|
-
* Use
|
|
4
|
+
* Use the Range factory methods to create valid ranges.
|
|
5
5
|
*/
|
|
6
6
|
export type Range<TNumericType extends NumericType = NumericType> = InclusiveRange<TNumericType> | ExclusiveRange<TNumericType>;
|
|
7
7
|
/**
|
|
8
8
|
* A finite numeric interval whose maximum value is included in the range.
|
|
9
|
-
* Use the {@link Range.createMaxInclusive} factory
|
|
9
|
+
* Use the {@link Range.safeCreateMaxInclusive} or {@link Range.createMaxInclusive} factory methods to create valid InclusiveRanges.
|
|
10
10
|
*/
|
|
11
11
|
export type InclusiveRange<TNumericType extends NumericType> = {
|
|
12
12
|
/**
|
|
@@ -32,7 +32,7 @@ export type InclusiveRange<TNumericType extends NumericType> = {
|
|
|
32
32
|
};
|
|
33
33
|
/**
|
|
34
34
|
* A finite numeric interval whose maximum value is excluded from the range.
|
|
35
|
-
* Use the {@link Range.createMaxExclusive} factory
|
|
35
|
+
* Use the {@link Range.safeCreateMaxExclusive} or {@link Range.createMaxExclusive} factory methods to create valid ExclusiveRanges.
|
|
36
36
|
*/
|
|
37
37
|
export type ExclusiveRange<TNumericType extends NumericType> = {
|
|
38
38
|
/**
|
|
@@ -61,20 +61,34 @@ type NumericType = "float" | "integer";
|
|
|
61
61
|
* Helpers for creating, validating, comparing, and narrowing numeric ranges.
|
|
62
62
|
*/
|
|
63
63
|
export declare const Range: {
|
|
64
|
+
/**
|
|
65
|
+
* Creates a range that includes its maximum value.
|
|
66
|
+
* The function throws if the Range parameters are invalid. You should use this for trusted code only.
|
|
67
|
+
*
|
|
68
|
+
* @param data The range values, excluding the discriminator added by this function.
|
|
69
|
+
*/
|
|
70
|
+
createMaxInclusive: <TNumericType extends NumericType>(data: Omit<InclusiveRange<TNumericType>, "type">) => InclusiveRange<TNumericType>;
|
|
64
71
|
/**
|
|
65
72
|
* Creates a range that includes its maximum value.
|
|
66
73
|
* The function returns a Failure if the Range parameters are invalid.
|
|
67
74
|
*
|
|
68
|
-
* @param
|
|
75
|
+
* @param data The range values, excluding the discriminator added by this function.
|
|
76
|
+
*/
|
|
77
|
+
safeCreateMaxInclusive: <TNumericType extends NumericType>(data: Omit<InclusiveRange<TNumericType>, "type">) => Result<InclusiveRange<TNumericType>, string>;
|
|
78
|
+
/**
|
|
79
|
+
* Creates a range that excludes its maximum value.
|
|
80
|
+
* The function throws if the Range parameters are invalid. You should use this for trusted code only.
|
|
81
|
+
*
|
|
82
|
+
* @param data The range values, excluding the discriminator added by this function.
|
|
69
83
|
*/
|
|
70
|
-
|
|
84
|
+
createMaxExclusive: <TNumericType extends NumericType>(data: Omit<ExclusiveRange<TNumericType>, "type">) => ExclusiveRange<TNumericType>;
|
|
71
85
|
/**
|
|
72
86
|
* Creates a range that excludes its maximum value.
|
|
73
87
|
* The function returns a Failure if the Range parameters are invalid.
|
|
74
88
|
*
|
|
75
89
|
* @param range The range values, excluding the discriminator added by this function.
|
|
76
90
|
*/
|
|
77
|
-
|
|
91
|
+
safeCreateMaxExclusive: <TNumericType extends NumericType>(range: Omit<ExclusiveRange<TNumericType>, "type">) => Result<ExclusiveRange<TNumericType>, string>;
|
|
78
92
|
/**
|
|
79
93
|
* Creates a new range with the same discriminator, numeric type, and limits as another range.
|
|
80
94
|
*
|
package/dist/Range.js
CHANGED
|
@@ -1,17 +1,29 @@
|
|
|
1
1
|
import { Result } from "./Result.js";
|
|
2
|
+
import { Assert } from "./Assert.js";
|
|
2
3
|
/**
|
|
3
4
|
* Helpers for creating, validating, comparing, and narrowing numeric ranges.
|
|
4
5
|
*/
|
|
5
6
|
export const Range = {
|
|
7
|
+
/**
|
|
8
|
+
* Creates a range that includes its maximum value.
|
|
9
|
+
* The function throws if the Range parameters are invalid. You should use this for trusted code only.
|
|
10
|
+
*
|
|
11
|
+
* @param data The range values, excluding the discriminator added by this function.
|
|
12
|
+
*/
|
|
13
|
+
createMaxInclusive: (data) => {
|
|
14
|
+
const rangeResult = Range.safeCreateMaxInclusive(data);
|
|
15
|
+
Assert.isSuccess(rangeResult);
|
|
16
|
+
return rangeResult.value;
|
|
17
|
+
},
|
|
6
18
|
/**
|
|
7
19
|
* Creates a range that includes its maximum value.
|
|
8
20
|
* The function returns a Failure if the Range parameters are invalid.
|
|
9
21
|
*
|
|
10
|
-
* @param
|
|
22
|
+
* @param data The range values, excluding the discriminator added by this function.
|
|
11
23
|
*/
|
|
12
|
-
|
|
24
|
+
safeCreateMaxInclusive: (data) => {
|
|
13
25
|
const inclusiveRange = {
|
|
14
|
-
...
|
|
26
|
+
...data,
|
|
15
27
|
type: "MaxInclusive",
|
|
16
28
|
};
|
|
17
29
|
const invalidReason = Range.validate(inclusiveRange);
|
|
@@ -20,13 +32,24 @@ export const Range = {
|
|
|
20
32
|
}
|
|
21
33
|
return Result.Success(inclusiveRange);
|
|
22
34
|
},
|
|
35
|
+
/**
|
|
36
|
+
* Creates a range that excludes its maximum value.
|
|
37
|
+
* The function throws if the Range parameters are invalid. You should use this for trusted code only.
|
|
38
|
+
*
|
|
39
|
+
* @param data The range values, excluding the discriminator added by this function.
|
|
40
|
+
*/
|
|
41
|
+
createMaxExclusive: (data) => {
|
|
42
|
+
const rangeResult = Range.safeCreateMaxExclusive(data);
|
|
43
|
+
Assert.isSuccess(rangeResult);
|
|
44
|
+
return rangeResult.value;
|
|
45
|
+
},
|
|
23
46
|
/**
|
|
24
47
|
* Creates a range that excludes its maximum value.
|
|
25
48
|
* The function returns a Failure if the Range parameters are invalid.
|
|
26
49
|
*
|
|
27
50
|
* @param range The range values, excluding the discriminator added by this function.
|
|
28
51
|
*/
|
|
29
|
-
|
|
52
|
+
safeCreateMaxExclusive: (range) => {
|
|
30
53
|
const exclusiveRange = {
|
|
31
54
|
...range,
|
|
32
55
|
type: "MaxExclusive",
|
|
@@ -46,14 +69,14 @@ export const Range = {
|
|
|
46
69
|
from: (fromRange, withValues) => {
|
|
47
70
|
switch (fromRange.type) {
|
|
48
71
|
case "MaxExclusive":
|
|
49
|
-
return Range.
|
|
72
|
+
return Range.safeCreateMaxExclusive({
|
|
50
73
|
numericType: fromRange.numericType,
|
|
51
74
|
min: withValues.min,
|
|
52
75
|
maxExclusive: withValues.max,
|
|
53
76
|
limits: fromRange.limits,
|
|
54
77
|
});
|
|
55
78
|
case "MaxInclusive":
|
|
56
|
-
return Range.
|
|
79
|
+
return Range.safeCreateMaxInclusive({
|
|
57
80
|
numericType: fromRange.numericType,
|
|
58
81
|
min: withValues.min,
|
|
59
82
|
maxInclusive: withValues.max,
|
package/dist/Range.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"Range.js","sourceRoot":"","sources":["../src/Range.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAA;AAwEpC;;GAEG;AACH,MAAM,CAAC,MAAM,KAAK,GAAG;IACnB;;;;;OAKG;IACH,kBAAkB,EAAE,CAClB,
|
|
1
|
+
{"version":3,"file":"Range.js","sourceRoot":"","sources":["../src/Range.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAA;AACpC,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAA;AAwEpC;;GAEG;AACH,MAAM,CAAC,MAAM,KAAK,GAAG;IACnB;;;;;OAKG;IACH,kBAAkB,EAAE,CAClB,IAAgD,EAClB,EAAE;QAChC,MAAM,WAAW,GAAG,KAAK,CAAC,sBAAsB,CAAC,IAAI,CAAC,CAAA;QACtD,MAAM,CAAC,SAAS,CAAC,WAAW,CAAC,CAAA;QAE7B,OAAO,WAAW,CAAC,KAAK,CAAA;IAC1B,CAAC;IAED;;;;;OAKG;IACH,sBAAsB,EAAE,CACtB,IAAgD,EACF,EAAE;QAChD,MAAM,cAAc,GAAiC;YACnD,GAAG,IAAI;YACP,IAAI,EAAE,cAAc;SACrB,CAAA;QAED,MAAM,aAAa,GAAG,KAAK,CAAC,QAAQ,CAAC,cAAc,CAAC,CAAA;QACpD,IAAI,aAAa,KAAK,SAAS,EAAE,CAAC;YAChC,OAAO,MAAM,CAAC,OAAO,CAAC,aAAa,CAAC,CAAA;QACtC,CAAC;QAED,OAAO,MAAM,CAAC,OAAO,CAAC,cAAc,CAAC,CAAA;IACvC,CAAC;IAED;;;;;OAKG;IACH,kBAAkB,EAAE,CAClB,IAAgD,EAClB,EAAE;QAChC,MAAM,WAAW,GAAG,KAAK,CAAC,sBAAsB,CAAC,IAAI,CAAC,CAAA;QACtD,MAAM,CAAC,SAAS,CAAC,WAAW,CAAC,CAAA;QAE7B,OAAO,WAAW,CAAC,KAAK,CAAA;IAC1B,CAAC;IAED;;;;;OAKG;IACH,sBAAsB,EAAE,CACtB,KAAiD,EACH,EAAE;QAChD,MAAM,cAAc,GAAiC;YACnD,GAAG,KAAK;YACR,IAAI,EAAE,cAAc;SACrB,CAAA;QAED,MAAM,aAAa,GAAG,KAAK,CAAC,QAAQ,CAAC,cAAc,CAAC,CAAA;QACpD,IAAI,aAAa,KAAK,SAAS,EAAE,CAAC;YAChC,OAAO,MAAM,CAAC,OAAO,CAAC,aAAa,CAAC,CAAA;QACtC,CAAC;QAED,OAAO,MAAM,CAAC,OAAO,CAAC,cAAc,CAAC,CAAA;IACvC,CAAC;IAED;;;;;OAKG;IACH,IAAI,EAAE,CACJ,SAAiB,EACjB,UAAwC,EAChB,EAAE;QAC1B,QAAQ,SAAS,CAAC,IAAI,EAAE,CAAC;YACvB,KAAK,cAAc;gBACjB,OAAO,KAAK,CAAC,sBAAsB,CAAC;oBAClC,WAAW,EAAE,SAAS,CAAC,WAAW;oBAClC,GAAG,EAAE,UAAU,CAAC,GAAG;oBACnB,YAAY,EAAE,UAAU,CAAC,GAAG;oBAC5B,MAAM,EAAE,SAAS,CAAC,MAAM;iBACzB,CAA2B,CAAA;YAC9B,KAAK,cAAc;gBACjB,OAAO,KAAK,CAAC,sBAAsB,CAAC;oBAClC,WAAW,EAAE,SAAS,CAAC,WAAW;oBAClC,GAAG,EAAE,UAAU,CAAC,GAAG;oBACnB,YAAY,EAAE,UAAU,CAAC,GAAG;oBAC5B,MAAM,EAAE,SAAS,CAAC,MAAM;iBACzB,CAA2B,CAAA;QAChC,CAAC;IACH,CAAC;IAED;;;;;OAKG;IACH,QAAQ,EAAE,CAAC,KAAY,EAAsB,EAAE;QAC7C,KAAK,MAAM,IAAI,IAAI,sBAAsB,EAAE,CAAC;YAC1C,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,CAAA;YAC1B,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;gBACzB,OAAO,MAAM,CAAA;YACf,CAAC;QACH,CAAC;QAED,OAAO,SAAS,CAAA;IAClB,CAAC;IAED;;;;;OAKG;IACH,QAAQ,EAAE,CAAC,KAAY,EAAE,KAAa,EAAW,EAAE;QACjD,IAAI,KAAK,GAAG,KAAK,CAAC,GAAG,EAAE,CAAC;YACtB,OAAO,KAAK,CAAA;QACd,CAAC;QAED,QAAQ,KAAK,CAAC,IAAI,EAAE,CAAC;YACnB,KAAK,cAAc;gBACjB,OAAO,KAAK,GAAG,KAAK,CAAC,YAAY,CAAA;YACnC,KAAK,cAAc;gBACjB,OAAO,KAAK,IAAI,KAAK,CAAC,YAAY,CAAA;QACtC,CAAC;IACH,CAAC;IAED;;;;;OAKG;IACH,QAAQ,EAAE,CAAmC,CAAsB,EAAE,CAAsB,EAAW,EAAE;QACtG,OAAO,KAAK,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,CAAC,IAAI,KAAK,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,CAAC,CAAA;IAC7D,CAAC;CACF,CAAA;AAGD,MAAM,sBAAsB,GAA0B;IACpD,WAAW;IACX,WAAW;IACX,oBAAoB;IACpB,oBAAoB;IACpB,mBAAmB;IACnB,cAAc;IACd,iBAAiB;IACjB,iBAAiB;CAClB,CAAA;AAED,SAAS,WAAW,CAAC,KAAyC;IAC5D,OAAO,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,6BAA6B,CAAA;AAC/E,CAAC;AACD,SAAS,WAAW,CAAC,KAAyC;IAC5D,OAAO,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,6BAA6B,CAAA;AACnF,CAAC;AAED,SAAS,oBAAoB,CAAC,KAAyC;IACrE,OAAO,KAAK,CAAC,WAAW,KAAK,OAAO,IAAI,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,iBAAiB,KAAK,CAAC,WAAW,SAAS,CAAA;AAC/H,CAAC;AACD,SAAS,oBAAoB,CAAC,KAAyC;IACrE,OAAO,KAAK,CAAC,WAAW,KAAK,OAAO,IAAI,MAAM,CAAC,SAAS,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,iBAAiB,KAAK,CAAC,WAAW,SAAS,CAAA;AACnI,CAAC;AAED,SAAS,mBAAmB,CAAC,KAAyC;IACpE,QAAQ,KAAK,CAAC,IAAI,EAAE,CAAC;QACnB,KAAK,cAAc;YACjB,OAAO,KAAK,CAAC,GAAG,GAAG,KAAK,CAAC,YAAY,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,4CAA4C,CAAA;QAClG,KAAK,cAAc;YACjB,OAAO,KAAK,CAAC,GAAG,IAAI,KAAK,CAAC,YAAY,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,mDAAmD,CAAA;IAC5G,CAAC;AACH,CAAC;AAED,SAAS,cAAc,CAAC,KAAyC;IAC/D,OAAO,KAAK,CAAC,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC,CAAA;AAC9E,CAAC;AAED,SAAS,iBAAiB,CAAC,KAAyC;IAClE,OAAO,KAAK,CAAC,MAAM,KAAK,SAAS,IAAI,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC,MAAM,EAAE,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,2BAA2B,CAAA;AACxH,CAAC;AACD,SAAS,iBAAiB,CAAC,KAAyC;IAClE,OAAO,KAAK,CAAC,MAAM,KAAK,SAAS,IAAI,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC,MAAM,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,2BAA2B,CAAA;AAC5H,CAAC;AAED,SAAS,MAAM,CAAC,KAAY;IAC1B,QAAQ,KAAK,CAAC,IAAI,EAAE,CAAC;QACnB,KAAK,cAAc;YACjB,OAAO,KAAK,CAAC,YAAY,CAAA;QAC3B,KAAK,cAAc;YACjB,OAAO,KAAK,CAAC,YAAY,CAAA;IAC7B,CAAC;AACH,CAAC"}
|