rambdax/_ts-toolbelt/src/Number/IsZero.ts

Extended version of Rambda - a lightweight, faster alternative to Ramda

import {IterationOf} from '../Iteration/IterationOf'
import {Iteration} from '../Iteration/Iteration'
import {Number} from './Number'
import {NumberMap} from '../Iteration/Maps/Number'
import {Map} from '../Iteration/Map'

/**
@hidden
*/
export type _IsZero<N extends Iteration> = {
    '-': 0
    '+': 0
    '0': 1
}[N[6]]

/**
Check whether a [[Number]] is null or not
@param N to check
@param IMap to operate with another set of numbers
@returns [[Boolean]]
@example
```ts
import {N} from 'ts-toolbelt'

type test0 = N.IsZero<'0'>  // True
type test1 = N.IsZero<'-7'> // False
type test2 = N.IsZero<'7'>  // False
```
*/
export type IsZero<N extends Number, IMap extends Map = NumberMap> =
    _IsZero<IterationOf<N, IMap>>