mirror of
https://github.com/bitburner-official/bitburner-src.git
synced 2024-11-08 08:43:53 +01:00
34 lines
1.2 KiB
Markdown
34 lines
1.2 KiB
Markdown
|
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||
|
|
|
||
|
|
[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [formatRam](./bitburner.ns.formatram.md)
|
||
|
|
|
||
|
|
## NS.formatRam() method
|
||
|
|
|
||
|
|
Format a number as an amount of ram.
|
||
|
|
|
||
|
|
**Signature:**
|
||
|
|
|
||
|
|
```typescript
|
||
|
|
formatRam(n: number, fractionalDigits?: number): string;
|
||
|
|
```
|
||
|
|
|
||
|
|
## Parameters
|
||
|
|
|
||
|
|
| Parameter | Type | Description |
|
||
|
|
| --- | --- | --- |
|
||
|
|
| n | number | Number to format as an amount of ram, in base units of GB (or GiB if that Numeric Display option is set). |
|
||
|
|
| fractionalDigits | number | _(Optional)_ Number of digits to show in the fractional part of the decimal number. Optional, defaults to 2. |
|
||
|
|
|
||
|
|
**Returns:**
|
||
|
|
|
||
|
|
string
|
||
|
|
|
||
|
|
Formatted ram amount.
|
||
|
|
|
||
|
|
## Remarks
|
||
|
|
|
||
|
|
RAM cost: 0 GB
|
||
|
|
|
||
|
|
Converts a number into a ram string with the specified number of fractional digits. This is the same function that the game itself uses to display ram. The format also depends on the Numeric Display settings (all options on the "Numeric Display" options page) To format plain numbers or percentages, see [formatNumber](./bitburner.ns.formatnumber.md) and [formatPercent](./bitburner.ns.formatpercent.md)
|
||
|
|
|