@wollybeard/kit

Appearance

Num.SafeInt ​

Num / SafeInt

Import ​

typescript
import { Num } from '@wollybeard/kit'

// Access via namespace
Num.SafeInt.someFunction()
typescript
import * as Num from '@wollybeard/kit/num'

// Access via namespace
Num.SafeInt.someFunction()

Functions ​

[F] is ​

typescript
(value: unknown): boolean
Source

Type predicate to check if value is a safe integer.

[F] from ​

typescript
(value: number): number & { [SafeIntBrand]: true; } & { [IntBrand]: true; }
Source

Construct a SafeInt. Throws if the value is not a safe integer.

[F] tryFrom ​

typescript
(value: number): (number & { [SafeIntBrand]: true; } & { [IntBrand]: true; }) | null
Source

Try to construct a SafeInt. Returns null if the value is not a safe integer.

Constants ​

[C] MAX_SAFE_INT ​

typescript
number & { [SafeIntBrand]: true; } & { [IntBrand]: true; }
Source

The maximum safe integer constant.

[C] MIN_SAFE_INT ​

typescript
number & { [SafeIntBrand]: true; } & { [IntBrand]: true; }
Source

The minimum safe integer constant.

Types ​

[∩] SafeInt ​

typescript
type SafeInt = number & { [SafeIntBrand]: true }
Source

Safe integer (within Number.MAX_SAFE_INTEGER).