Type Alias Integer<T>

Integer: T extends unknown ? IsInteger<T> extends true ? T : never : never

A number that is an integer.

Use-case: Validating and documenting parameters.

Type Parameters

T

Example

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

type SomeInteger = Integer<1>;
//=> 1

type IntegerWithDecimal = Integer<1.0>;
//=> 1

type NegativeInteger = Integer<-1>;
//=> -1

type Float = Integer<1.5>;
//=> never

// Supports non-decimal numbers

type OctalInteger = Integer<0o10>;
//=> 8

type BinaryInteger = Integer<0b10>;
//=> 2

type HexadecimalInteger = Integer<0x10>;
//=> 16

Example

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

declare function setYear<T extends number>(length: Integer<T>): void;

See