bitburner-src/markdown/bitburner.ns.nformat.md
Olivier Gagnon feb0430aff work on doc
2021-10-30 15:46:34 -04:00

32 lines
742 B
Markdown

<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [NS](./bitburner.ns.md) &gt; [nFormat](./bitburner.ns.nformat.md)
## NS.nFormat() method
Converts a number into a string with the specified formatter. This uses the numeraljs library, so the formatters must be compatible with that. This is the same function that the game itself uses to display numbers.
<b>Signature:</b>
```typescript
nFormat(n: number, format: string): number;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| n | number | Number to format. |
| format | string | Formatter. |
<b>Returns:</b>
number
Formated number.
## Remarks
RAM cost: 0 GB