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

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