-
-
Notifications
You must be signed in to change notification settings - Fork 679
Expand file tree
/
Copy pathgreater-than.d.ts
More file actions
92 lines (76 loc) · 2.42 KB
/
greater-than.d.ts
File metadata and controls
92 lines (76 loc) · 2.42 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
import type {PositiveNumericStringGt} from './internal/index.d.ts';
import type {IsEqual} from './is-equal.d.ts';
import type {PositiveInfinity, NegativeInfinity, IsNegative} from './numeric.d.ts';
import type {And} from './and.d.ts';
import type {Or} from './or.d.ts';
import type {Absolute} from './absolute.d.ts';
/**
Returns a boolean for whether a given number is greater than another number.
@example
```
import type {GreaterThan} from 'type-fest';
type A = GreaterThan<1, -5>;
//=> true
type B = GreaterThan<1, 1>;
//=> false
type C = GreaterThan<1, 5>;
//=> false
```
Note: If either argument is the non-literal `number` type, the result is `boolean`.
@example
```
import type {GreaterThan} from 'type-fest';
type A = GreaterThan<number, 1>;
//=> boolean
type B = GreaterThan<1, number>;
//=> boolean
type C = GreaterThan<number, number>;
//=> boolean
```
@example
```
import type {GreaterThan} from 'type-fest';
// Use `GreaterThan` to constrain a function parameter to positive numbers.
declare function setPositive<N extends number>(value: GreaterThan<N, 0> extends true ? N : never): void;
setPositive(1); // ✅ Allowed
setPositive(2); // ✅ Allowed
// @ts-expect-error
setPositive(0);
// @ts-expect-error
setPositive(-1);
```
*/
export type GreaterThan<A extends number, B extends number> =
A extends number // For distributing `A`
? B extends number // For distributing `B`
? number extends A | B
? boolean
: [
IsEqual<A, PositiveInfinity>, IsEqual<A, NegativeInfinity>,
IsEqual<B, PositiveInfinity>, IsEqual<B, NegativeInfinity>,
] extends infer R extends [boolean, boolean, boolean, boolean]
? Or<
And<IsEqual<R[0], true>, IsEqual<R[2], false>>,
And<IsEqual<R[3], true>, IsEqual<R[1], false>>
> extends true
? true
: Or<
And<IsEqual<R[1], true>, IsEqual<R[3], false>>,
And<IsEqual<R[2], true>, IsEqual<R[0], false>>
> extends true
? false
: true extends R[number]
? false
: [IsNegative<A>, IsNegative<B>] extends infer R extends [boolean, boolean]
? [true, false] extends R
? false
: [false, true] extends R
? true
: [false, false] extends R
? PositiveNumericStringGt<`${A}`, `${B}`>
: PositiveNumericStringGt<`${Absolute<B>}`, `${Absolute<A>}`>
: never
: never
: never // Should never happen
: never; // Should never happen
export {};