FilesExpand file tree

main

/

greater-than-or-equal.d.ts

Copy path

Blame

More file actions

Blame

More file actions

Latest commit

 

History

History

History

63 lines (47 loc) · 1.39 KB

main

/

greater-than-or-equal.d.ts

Copy path

Top

File metadata and controls

• Code
• Blame

63 lines (47 loc) · 1.39 KB

Raw

Copy raw file

Download raw file

Open symbols panel

Edit and raw actions

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

import type {GreaterThan} from './greater-than.d.ts';

/**

Returns a boolean for whether a given number is greater than or equal to another number.

@example

```

import type {GreaterThanOrEqual} from 'type-fest';

type A = GreaterThanOrEqual<1, -5>;

//=> true

type B = GreaterThanOrEqual<1, 1>;

//=> true

type C = GreaterThanOrEqual<1, 5>;

//=> false

```

Note: If either argument is the non-literal `number` type, the result is `boolean`.

@example

```

import type {GreaterThanOrEqual} from 'type-fest';

type A = GreaterThanOrEqual<number, 1>;

//=> boolean

type B = GreaterThanOrEqual<1, number>;

//=> boolean

type C = GreaterThanOrEqual<number, number>;

//=> boolean

```

@example

```

import type {GreaterThanOrEqual} from 'type-fest';

// Use `GreaterThanOrEqual` to constrain a function parameter to non-negative numbers.

declare function setNonNegative<N extends number>(value: GreaterThanOrEqual<N, 0> extends true ? N : never): void;

setNonNegative(0); // ✅ Allowed

setNonNegative(1); // ✅ Allowed

// @ts-expect-error

setNonNegative(-1);

// @ts-expect-error

setNonNegative(-2);

```

*/

export type GreaterThanOrEqual<A extends number, B extends number> = number extends A | B

? boolean

: A extends number // For distributing `A`

? B extends number // For distributing `B`

? A extends B

? true

: GreaterThan<A, B>

: never // Should never happen

: never; // Should never happen

export {};