Class BigNum

Hierarchy

  • BigNum

Constructors

Properties

precision: BN
val: BN
delim: string = '.'
spacer: string = ','

Methods

  • Parameters

    • bn: any
    • Optional ignorePrecision: boolean

    Returns boolean

  • Parameters

    • bn: any
    • Optional ignorePrecision: boolean

    Returns boolean

  • Parameters

    • bn: any
    • Optional ignorePrecision: boolean

    Returns boolean

  • Parameters

    • bn: any
    • Optional ignorePrecision: boolean

    Returns boolean

  • Parameters

    • bn: any
    • Optional ignorePrecision: boolean

    Returns boolean

  • Parameters

    • Optional useTradePrecision: boolean
    • Optional precisionOverride: number

    Returns string

  • Pretty print the underlying value in human-readable form. Depends on precision being correct for the output string to be correct

    Returns

    Returns string

  • Print and remove unnecessary trailing zeroes

    Returns

    Parameters

    • Optional useTradePrecision: boolean
    • Optional precisionOverride: number

    Returns string

  • Multiplies by another big number then scales the result down by the big number's precision so that we're in the same precision space

    Returns

    Parameters

    • bn: any

    Returns BigNum

  • Shift precision up or down

    Returns

    Parameters

    • exponent: any
    • skipAdjustingPrecision: boolean = false

    Returns BigNum

  • Pretty print with the specified number of decimal places

    Returns

    Parameters

    • fixedPrecision: number
    • rounded: boolean = false

    Returns string

  • Returns {
        precision: any;
        val: any;
    }

    • precision: any
    • val: any
  • Parameters

    • precision: number = 3
    • rounded: boolean = false

    Returns string

  • Print dollar formatted value. Defaults to fixed decimals two unless a given precision is given.

    Returns

    Parameters

    • Optional useTradePrecision: boolean
    • Optional precisionOverride: number

    Returns string

  • Get the numerical value of the BigNum. This can break if the BigNum is too large.

    Returns

    Returns number

  • Pretty print to the specified number of significant figures

    Returns

    Parameters

    • fixedPrecision: number
    • trailingZeroes: boolean = false
    • rounded: boolean = false

    Returns string

  • Parameters

    • Optional base: number | "hex"
    • Optional length: number

    Returns string

  • Parameters

    • json: {
          precision: string;
          val: string;
      }
      • precision: string
      • val: string

    Returns BigNum

  • Create a BigNum instance from a printed BigNum

    Returns

    Parameters

    • val: string
    • Optional precisionShift: BN

    Returns BigNum

Generated using TypeDoc