bitburner-src/markdown/bitburner.ns.rm.md
omuretsu 06a985bdf8 Revert "Remove markdown from git tracking (#139)"
This reverts commit bbb6e3f309935aebac74ddb1fbeec12dfb7540b1.
2022-10-21 11:16:00 -04:00

34 lines
816 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; [rm](./bitburner.ns.rm.md)
## NS.rm() method
Delete a file.
<b>Signature:</b>
```typescript
rm(name: string, host?: string): boolean;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| name | string | Filename of file to remove. Must include the extension. |
| host | string | Host Address of the server on which to delete the file. Optional. Defaults to current server. |
<b>Returns:</b>
boolean
True if it successfully deletes the file, and false otherwise.
## Remarks
RAM cost: 1 GB
Removes the specified file from the current server. This function works for every file type except message (.msg) files.