Skip to main content

formatCompactNumber

Stock Screening Platform - Frontend API v0.1.0

Stock Screening Platform - Frontend API / utils/formatNumber / formatCompactNumber

Function: formatCompactNumber()

formatCompactNumber(num, decimals): string

Defined in: src/utils/formatNumber.ts:22

Format number in compact international notation

Converts large numbers to K/M/B/T notation

Parameters​

num​

Number to format

number | null | undefined

decimals​

number = 1

Number of decimal places (default: 1)

Returns​

string

Formatted string

Example​

formatCompactNumber(1500) // "1.5K"
formatCompactNumber(2500000) // "2.5M"
formatCompactNumber(1234567890) // "1.2B"