UNPKG

ts-toolbelt/out/Number/LowerEq.d.ts

Version:

466 BTypeScriptView Raw

1import { GreaterEq } from './GreaterEq';
2/**
* Check if a [[Number]] is lower or equal to another one
* @param N1 to compare
* @param N2 to compare to
* @returns [[Boolean]]
* @example
* ```ts
* import {N} from 'ts-toolbelt'
*
* type test0 = N.LowerEq<'7', '5'> // False
* type test1 = N.LowerEq<'5', '5'> // True
* type test2 = N.LowerEq<'5', '7'> // True
* ```
*/
16export declare type LowerEq<N1 extends number, N2 extends number> = GreaterEq<N2, N1>;

1	`import { GreaterEq } from './GreaterEq';`
2	`/**`
3	`* Check if a [[Number]] is lower or equal to another one`
4	`* @param N1 to compare`
5	`* @param N2 to compare to`
6	`* @returns [[Boolean]]`
7	`* @example`
8	* ```ts
9	`* import {N} from 'ts-toolbelt'`
10	`*`
11	`* type test0 = N.LowerEq<'7', '5'> // False`
12	`* type test1 = N.LowerEq<'5', '5'> // True`
13	`* type test2 = N.LowerEq<'5', '7'> // True`
14	* ```
15	`*/`
16	`export declare type LowerEq<N1 extends number, N2 extends number> = GreaterEq<N2, N1>;`