IntFromString overview

Added in v1.0.0

---

Table of contents

• Conversion
  • IntFromString
• Pattern
  • intFromString
• utils
  • IntString (type alias)

---

Conversion

IntFromString

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

Note: has an optional encodeToBase parameter that controls the output base of the encoded string. Currently only decodes binary, octal, decimal, and hexadecimal input bases. It decodes in any base, and encodes to supplied parameter defaulting to decimal.

Note: Does not currently allow exponential notation (e.g. 0x123e4).

Represents string-integers:

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

Signature

export declare const IntFromString: Schema<
  Opaque<string, IntStringBrand<-9007199254740991, 9007199254740991>>,
  Opaque<number, IntBrand<-9007199254740991, 9007199254740991>>
>

Added in v1.0.0

Pattern

intFromString

Signature

export declare const intFromString: k.Pattern

Added in v1.0.0

utils

IntString (type alias)

A string that can safely be parsed to a floating point number.

Signature

export type IntString<Min = MinSafeInt, Max = MaxSafeInt> = Branded<string, IntStringBrand<Min, Max>>

Added in v2.0.0