@exodus/formatting
Version: 0.0.0
Functions
asOrdinal
formatAssetAmount
formatAssetPrice
formatBytes
formatCurrency
formatPercentage
formatPriceUSD
getCurrencyFormat
getCurrencySymbol
pad
padDecimals
roundDecimalSignificantsUp
toCamelCase
toFirstLower
toFirstUpper
toKebapCase
toPascalCase
toPlainDecimalString
toSnakeCase
toUpperSnakeCase
truncate
truncateDecimalSignificantsDown
truncateMiddle
asOrdinal
canShowPlusSign
formatAmount
formatAssetAmount
formatAssetPrice
formatBalance
formatBytes
formatCurrency
formatNumber
formatPercentage
formatPrice
formatPriceUSD
getCurrencyFormat
getCurrencySymbol
getFiatAdaptiveFraction
pad
padDecimals
pluralize
roundDecimalSignificantsUp
toCamelCase
toFirstLower
toFirstUpper
toKebapCase
toPascalCase
toPlainDecimalString
toSnakeCase
toUpperSnakeCase
truncate
truncateDecimalSignificantsDown
truncateMiddle
hasLeftCurrencySymbol
Type Aliases
canShowPlusSign
variable
Type
const canShowPlusSign: (amount: Amount) => booleanformatAmount
variable
Type
const formatAmount: (amount: string | number, { minimumFractionDigits, ...rest }: FormatPriceOptions) => stringSignature
Parameters:
amount: string | number
{ minimumFractionDigits, ...rest } (optional): FormatPriceOptions
Returns:
stringformatBalance
variable
Type
const formatBalance: (balance: Amount, asset: { ... }) => stringformatNumber
variable
Type
const formatNumber: (number: string | number, decimals: number) => stringSignature
__type(number: string | number, decimals?: number): string
Parameters:
number: string | number
decimals (optional): number
Returns:
stringformatPrice
variable
Type
const formatPrice: (price: string | number, { useGrouping, currency, format, minimumFractionDigits, maxFraction, formatZeroWithoutDecimals, }: FormatPriceOptions) => stringSignature
__type(price: string | number, { useGrouping, currency, format, minimumFractionDigits, maxFraction, formatZeroWithoutDecimals, }?: FormatPriceOptions): string
Parameters:
price: string | number
{ useGrouping, currency, format, minimumFractionDigits, maxFraction, formatZeroWithoutDecimals, } (optional): FormatPriceOptions
Returns:
stringgetFiatAdaptiveFraction
variable
Type
const getFiatAdaptiveFraction: (price: string | number) => 2 | 6 | 4Signature
__type(price: string | number): 2 | 6 | 4
Parameters:
price: string | number
Returns:
2 | 6 | 4LEFT_FORMAT
variable
Type
"%s%v"
pluralize
variable
Type
const pluralize: (string: string, number: number) => stringSignature
__type(string: string, number: number): string
Parameters:
string: string
number: number
Returns:
stringRIGHT_FORMAT
variable
Type
"%v %s"
USD_SYMBOL
variable
Type
string
asOrdinal
function
Signature
asOrdinal(number: number): string
Parameters:
number: number
Returns:
stringformatAssetAmount
function
formatAssetPrice
function
Signature
formatAssetPrice(__namedParameters: any): string
Parameters:
__namedParameters: any
Returns:
stringformatBytes
function
Signature
formatBytes(bytes: number): string
Parameters:
bytes: number
Returns:
stringformatCurrency
function
Signature
Parameters:
amount (optional): string | number
opts (optional): FormatCurrencyOptions
Returns:
stringformatPercentage
function
Signature
formatPercentage(percentage: undefined | null | string | number, noPlus?: boolean): string
Parameters:
percentage: undefined | null | string | number
noPlus (optional): boolean
Returns:
stringformatPriceUSD
function
Signature
formatPriceUSD(price: string | number): string
Parameters:
price: string | number
Returns:
stringgetCurrencyFormat
function
Signature
getCurrencyFormat(currency: string): "%s%v" | "%v %s"
Parameters:
currency: string
Returns:
"%s%v" | "%v %s"getCurrencySymbol
function
Signature
getCurrencySymbol(currency: string): undefined | string
Parameters:
currency: string
Returns:
undefined | stringpad
function
Signature
Parameters:
input: string | number
__namedParameters: PadOptions
Returns:
stringpadDecimals
function
Signature
padDecimals(value: string | number, length: number): string
Parameters:
value: string | number
length: number
Returns:
stringroundDecimalSignificantsUp
function
Signature
roundDecimalSignificantsUp(value: T, significantDigits?: number): T
Parameters:
value: T
significantDigits (optional): number
Returns:
TtoCamelCase
function
Signature
toCamelCase(input: string): string
Parameters:
input: string
Returns:
stringtoFirstLower
function
Signature
toFirstLower(input: string): string
Parameters:
input: string
Returns:
stringtoFirstUpper
function
Signature
toFirstUpper(input: string): string
Parameters:
input: string
Returns:
stringtoKebapCase
function
Signature
toKebapCase(text: string): string
Parameters:
text: string
Returns:
stringtoPascalCase
function
Signature
toPascalCase(input: string): string
Parameters:
input: string
Returns:
stringtoPlainDecimalString
function
Signature
toPlainDecimalString(value: string | number): string
Parameters:
value: string | number
Returns:
stringtoSnakeCase
function
Signature
toSnakeCase(text: string): string
Parameters:
text: string
Returns:
stringtoUpperSnakeCase
function
Signature
toUpperSnakeCase(text: string): string
Parameters:
text: string
Returns:
stringtruncate
function
Signature
Parameters:
text: string
__namedParameters: TruncateOptions
Returns:
stringtruncateDecimalSignificantsDown
function
Signature
truncateDecimalSignificantsDown(value: T, significantDigits?: number): T
Parameters:
value: T
significantDigits (optional): number
Returns:
TtruncateMiddle
function
Signature
Parameters:
text: string
__namedParameters: TruncateOptions
Returns:
stringLEFT_FORMAT
variable
Type
"%s%v"
RIGHT_FORMAT
variable
Type
"%v %s"
USD_SYMBOL
variable
Type
string
asOrdinal
function
Signature
asOrdinal(number: number): string
Parameters:
number: number
Returns:
stringcanShowPlusSign
formatAmount
function
Signature
Parameters:
amount: string | number
__namedParameters: FormatPriceOptions
Returns:
stringformatAssetAmount
function
formatAssetPrice
function
Signature
formatAssetPrice(__namedParameters: any): string
Parameters:
__namedParameters: any
Returns:
stringformatBalance
function
formatBytes
function
Signature
formatBytes(bytes: number): string
Parameters:
bytes: number
Returns:
stringformatCurrency
function
Signature
Parameters:
amount (optional): string | number
opts (optional): FormatCurrencyOptions
Returns:
stringformatNumber
function
Signature
formatNumber(number: string | number, decimals: number): string
Parameters:
number: string | number
decimals: number
Returns:
stringformatPercentage
function
Signature
formatPercentage(percentage: undefined | null | string | number, noPlus: boolean): string
Parameters:
percentage: undefined | null | string | number
noPlus: boolean
Returns:
stringformatPrice
function
Signature
Parameters:
price: string | number
__namedParameters: FormatPriceOptions
Returns:
stringformatPriceUSD
function
Signature
formatPriceUSD(price: string | number): string
Parameters:
price: string | number
Returns:
stringgetCurrencyFormat
function
Signature
getCurrencyFormat(currency: string): "%s%v" | "%v %s"
Parameters:
currency: string
Returns:
"%s%v" | "%v %s"getCurrencySymbol
function
Signature
getCurrencySymbol(currency: string): undefined | string
Parameters:
currency: string
Returns:
undefined | stringgetFiatAdaptiveFraction
function
Signature
getFiatAdaptiveFraction(price: string | number): 2 | 4 | 6
Parameters:
price: string | number
Returns:
2 | 4 | 6pad
function
Signature
Parameters:
input: string | number
__namedParameters: PadOptions
Returns:
stringpadDecimals
function
Signature
padDecimals(value: string | number, length: number): string
Parameters:
value: string | number
length: number
Returns:
stringpluralize
function
Signature
pluralize(string: string, number: number): string
Parameters:
string: string
number: number
Returns:
stringroundDecimalSignificantsUp
function
Signature
roundDecimalSignificantsUp(value: T, significantDigits: number): T
Parameters:
value: T
significantDigits: number
Returns:
TtoCamelCase
function
Signature
toCamelCase(input: string): string
Parameters:
input: string
Returns:
stringtoFirstLower
function
Signature
toFirstLower(input: string): string
Parameters:
input: string
Returns:
stringtoFirstUpper
function
Signature
toFirstUpper(input: string): string
Parameters:
input: string
Returns:
stringtoKebapCase
function
Signature
toKebapCase(text: string): string
Parameters:
text: string
Returns:
stringtoPascalCase
function
Signature
toPascalCase(input: string): string
Parameters:
input: string
Returns:
stringtoPlainDecimalString
function
Signature
toPlainDecimalString(value: string | number): string
Parameters:
value: string | number
Returns:
stringtoSnakeCase
function
Signature
toSnakeCase(text: string): string
Parameters:
text: string
Returns:
stringtoUpperSnakeCase
function
Signature
toUpperSnakeCase(text: string): string
Parameters:
text: string
Returns:
stringtruncate
function
Signature
Truncates a text so that it is less than maxLen, keeps words intact
Parameters:
text: string
__namedParameters: TruncateOptions
Returns:
stringtruncateDecimalSignificantsDown
function
Signature
truncateDecimalSignificantsDown(value: T, significantDigits: number): T
Truncates (floors) decimal digits to fit within a digit budget.
Note: `significantDigits` is a digit budget, not true significant-figure rounding.
After accounting for digits in the integer part, the remaining budget is applied as
a maximum number of decimal places from the decimal point, so leading zeros in the
fractional part do count toward the budget.
This mirrors the behavior of `roundDecimalSignificantsUp`.
Parameters:
value: T
significantDigits: number
Returns:
TtruncateMiddle
function
Signature
Parameters:
text: string
__namedParameters: TruncateOptions
Returns:
stringUnit
type
Properties
symbol
string
units
variable
Type
const units: {
USD: Unit
}units
variable
Type
const units: {
USD: any
}hasLeftCurrencySymbol
function
Signature
hasLeftCurrencySymbol(currency: string): boolean
Parameters:
currency: string
