mirror of
https://github.com/bitburner-official/bitburner-src.git
synced 2024-12-22 14:12:27 +01:00
36 lines
1.4 KiB
Markdown
36 lines
1.4 KiB
Markdown
|
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||
|
|
|
||
|
|
[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [formatNumber](./bitburner.ns.formatnumber.md)
|
||
|
|
|
||
|
|
## NS.formatNumber() method
|
||
|
|
|
||
|
|
Format a number.
|
||
|
|
|
||
|
|
**Signature:**
|
||
|
|
|
||
|
|
```typescript
|
||
|
|
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](./bitburner.ns.formatram.md) and [formatPercent](./bitburner.ns.formatpercent.md)
|
||
|
|
|