Skip to content
Permalink
Branch: master
Find file Copy path
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
121 lines (87 sloc) 3.32 KB

Computation

  • formatSignificant
    • Function Signature
    • Input Parameters
    • Example Usage
  • formatSignificantDecimals
    • Function Signature
    • Input Parameters
    • Example Usage
  • formatFixed
    • Function Signature
    • Input Parameters
    • Example Usage
  • formatFixedDecimals
    • Function Signature
    • Input Parameters
    • Example Usage

formatSignificant

This function formats values to a specified number of significant digits.

Function Signature

export function formatSignificant(bigNumberish: BigNumberish, options?: FormatSignificantOptions): string

Input Parameters

Parameter Type Description
bigNumberish BigNumberish The value to be formatted.
options? FormatSignificantOptions Formatting options.

Example Usage

const formatted: string = formatSignificant('123456', { significantDigits: 3 }) // 1.23

formatSignificantDecimals

This function formats token and ethereum values to a specified number of significant digits.

Function Signature

export function formatSignificantDecimals(
  bigNumberish: BigNumberish,
  decimals: number,
  options?: FormatSignificantOptions
): string

Input Parameters

Parameter Type Description
bigNumberish BigNumberish The value to be formatted.
decimals number The decimals of the passed value.
options? FormatSignificantOptions Formatting options.

Example Usage

const formatted: string = formatSignificantDecimals('1234560000000000000', 18, { significantDigits: 3 }) // 1.23

formatFixed

This function formats values to a specified number of decimal places.

Function Signature

export function formatFixed(bigNumberish: BigNumberish, options?: FormatFixedOptions): string

Input Parameters

Parameter Type Description
bigNumberish BigNumberish The value to be formatted.
options? FormatFixedOptions Formatting options.

Example Usage

const formatted: string = formatFixed('1.2345', { decimalPlaces: 2 }) // 1.23

formatFixedDecimals

This function formats token and ethereum values to a specified number of decimal places.

Function Signature

export function formatFixedDecimals(
  bigNumberish: BigNumberish,
  decimals: number,
  options?: FormatFixedOptions
): string

Input Parameters

Parameter Type Description
bigNumberish BigNumberish The value to be formatted.
decimals number The decimals of the passed value.
options? FormatFixedOptions Formatting options.

Example Usage

const formatted: string = formatFixedDecimals('1234560000000000000', 18, { decimalPlaces: 2 }) // 1.23
You can’t perform that action at this time.