bitburner-src/markdown/bitburner.ns.formatnumber.md

Home > bitburner > NS > formatNumber

NS.formatNumber() method

Format a number.

Signature:

formatNumber(n: number, fractionalDigits?: number, suffixStart?: number, isInteger?: boolean): string;

Parameters

Parameter	Type	Description
n	number	Number to format.
fractionalDigits	number	(Optional) Number of digits to show in the fractional part of the decimal number. Optional, defaults to 3.
suffixStart	number	(Optional) How high a number must be before a suffix will be added. Optional, defaults to 1000.
isInteger	boolean	(Optional) Whether the number represents an integer. Integers do not display fractional digits until a suffix is present. Optional, defaults to false.

Returns:

string

Formatted number.

Remarks

RAM cost: 0 GB

Converts a number into a numeric string with the specified format options. This is the same function that the game itself uses to display numbers. The format also depends on the Numeric Display settings (all options on the "Numeric Display" options page) To format ram or percentages, see formatRam and formatPercent