work on doc

markdown/bitburner.singularity.getaugmentationstats.md

@@ -0,0 +1,32 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [Singularity](./bitburner.singularity.md) &gt; [getAugmentationStats](./bitburner.singularity.getaugmentationstats.md)
+
+## Singularity.getAugmentationStats() method
+
+If you are not in BitNode-4, then you must have Level 3 of Source-File 4 in order to use this function and the RAM cost is doubled.
+
+This function returns augmentation stats.
+
+<b>Signature:</b>
+
+```typescript
+getAugmentationStats(name: AugmentName): AugmentationStats;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  name | [AugmentName](./bitburner.augmentname.md) | Name of Augmentation. CASE-SENSITIVE. |
+
+<b>Returns:</b>
+
+[AugmentationStats](./bitburner.augmentationstats.md)
+
+Augmentation stats.
+
+## Remarks
+
+5 GB  Level 3
+