work on doc

markdown/bitburner.ns.nformat.md

@@ -0,0 +1,31 @@
+<!-- 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
+
+0 GB
+