Personal_mirrors/bitburner-src
1
0
Fork 0
mirror of https://github.com/bitburner-official/bitburner-src.git synced 2024-11-24 00:23:49 +01:00
Code Issues Packages Projects Releases Wiki Activity
70a231e421
bitburner-src/markdown/bitburner.ns.formatpercent.md

1.2 KiB
Raw Blame History

Home > bitburner > NS > formatPercent

NS.formatPercent() method

Format a number as a percentage.

Signature:

formatPercent(n: number, fractionalDigits?: number, suffixStart?: number): string;

Parameters

Parameter Type Description
n number Number to format as a percentage.
fractionalDigits number (Optional) Number of digits to show in the fractional part of the decimal number. Optional, defaults to 2.
suffixStart number (Optional) When to switch the percentage to a multiplier. Default is 1e6 or x1.00m.

Returns:

string

Formatted percentage.

Remarks

RAM cost: 0 GB

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