Type Alias Integer<T>

Integer: `${T}` extends `${bigint}` ? T : never

A number that is an integer. You can't pass a bigint as they are already guaranteed to be integers.

Use-case: Validating and documenting parameters.

Type Parameters

  • T extends number

Example

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

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

See

  • NegativeInteger
  • NonNegativeInteger

Settings

Member Visibility