BigIntFromString overview

Added in v1.0.0

---

Table of contents

• Conversion
  • BigIntFromString
• Pattern
  • bigIntString
• utils
  • BigIntFromStringParams (type alias)
  • BigIntString (type alias)

---

Conversion

BigIntFromString

Represents bigints converted from strings

Signature

export declare const BigIntFromString: Schema<Opaque<string, BigIntStringBrand>, bigint>

Added in v1.0.0

Pattern

bigIntString

Signature

export declare const bigIntString: k.Pattern

Added in v1.0.0

utils

BigIntFromStringParams (type alias)

Controls the output base of the encoded string. Currently only accepts 2, 8, 10, and 16. It does not decode in this specified base, and accepts any base as input: 2, 8, 10, or 16.

Signature

export type BigIntFromStringParams = {
  readonly encodeToBase?: 2 | 8 | 10 | 16
}

Added in v1.0.0

BigIntString (type alias)

Represents strings that can be parsed properly by BigInt()

Signature

export type BigIntString = Branded<string, BigIntStringBrand>

Added in v2.0.0