Value.format

Formats a bigint Value to its string representation (divided by the given exponent).

Imports

import { Value } from 'ox'

Examples

import { Value } from 'ox'
 
Value.format(420_000_000_000n, 9)
'420'

Definition

function format(
  value: bigint,
  decimals?: number,
): string

Source: src/core/Value.ts

Parameters

value

• Type: bigint

The bigint Value to format.

decimals

• Type: number
• Optional

The exponent to divide the bigint Value by.

Return Type

The string representation of the Value.

string