bitburner-src/markdown/bitburner.ns.nformat.md

36 lines
787 B
Markdown
Raw Normal View History

2021-10-30 18:34:14 +02:00
<!-- 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
Format a number
2021-10-30 18:34:14 +02:00
<b>Signature:</b>
```typescript
2022-01-08 19:25:06 +01:00
nFormat(n: number, format: string): string;
2021-10-30 18:34:14 +02:00
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| n | number | Number to format. |
| format | string | Formatter. |
<b>Returns:</b>
2022-01-08 19:25:06 +01:00
string
2021-10-30 18:34:14 +02:00
Formated number.
## Remarks
2021-10-30 21:46:34 +02:00
RAM cost: 0 GB
2021-10-30 18:34:14 +02:00
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.
see: http://numeraljs.com/