integer.md

title	nav_order	permalink
integer.ts	7	/integer/

integer overview

Integer represents valid/safe javascript integer numbers within (and tagged with) a certain range.

Added in v2.0.0

---

Table of contents

• Model
  • Integer (type alias)
  • MaxSafeInt (type alias)
  • MinSafeInt (type alias)
• utils
  • IntBrand (interface)
  • maxSafeInt
  • minSafeInt

---

Model

Integer (type alias)

Integer branded newtype. Parameters: min, max are inclusive.

Represents integers:

$${ z | z ∈ ℤ, z >= -2 ** 53 + 1, z <= 2 ** 53 - 1 }$$

Signature

export type Integer<Min extends number = MinSafeInt, Max extends number = MaxSafeInt> = Branded<
  number,
  IntBrand<Min, Max>
>

Added in v1.0.0

MaxSafeInt (type alias)

The largest safe integer in JavaScript.

Signature

export type MaxSafeInt = 9007199254740991

Added in v2.0.0

MinSafeInt (type alias)

The smallest safe integer in JavaScript.

Signature

export type MinSafeInt = -9007199254740991

Added in v2.0.0

utils

IntBrand (interface)

A brand for bounded integers.

Signature

export interface IntBrand<Min extends number, Max extends number> {
  readonly Int: unique symbol
  readonly Min: Min
  readonly Max: Max
}

Added in v2.2.1

maxSafeInt

The largest safe integer in JavaScript.

Signature

export declare const maxSafeInt: 9007199254740991

Added in v2.0.0

minSafeInt

The smallest safe integer in JavaScript.

Signature

export declare const minSafeInt: -9007199254740991

Added in v2.0.0