dcd2f33f7c
* Update api-documentor and api-extractor. #1566 follow-up.
I have verified that the HTML/markdown table generation bug in
[#4878](https://github.com/microsoft/rushstack/issues/4878) in rushstack
for api-documentor has been fixed as per rushstack#5256. The testcase
[repro](https://github.com/catloversg/api-documenter-bug-pr-4578) now
produces the correct expected output.
I have confirmed that the generated output in bitburner from
`npm run doc` now generated HTML tables, and correctly inserts
a blank line between the </table> and the follow line (e.g. Returns).
Stylisticly it could use some whitespace, but it is correctly rendered.
This commit is only the updated packages, not the updated generated
documentation. I assume that is automatically generated by the GitHub
workflow.
* Follow up to 5f732a6f35, include `npm run doc` changed docs.
* Add missing license info
* Fix React warning
---------
Co-authored-by: CatLover <152669316+catloversg@users.noreply.github.com>
2.2 KiB
Home > bitburner > Format > number
Format.number() method
Format a number.
Signature:
number(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 format.ram and format.percent
This function has some quirky undocumented behaviors. This is a non-exhaustive list of those behaviors:
-
"Infinity" and "-Infinity" are returned as "∞" and "-∞", respectively.
-
If you disable the suffix form in the settings page or the absolute value is greater than or equal to 1e33, this function will use the exponential form. This means that, if Math.abs(n) >= 1e33, the returned value is always in the exponential form, regardless of the setting.
Note that the behaviors listed above are "undocumented", in the sense that we don't make any guarantee about backward compatibility. You must not rely on those behaviors.