mirror of
https://github.com/bitburner-official/bitburner-src.git
synced 2024-11-09 01:03:54 +01:00
32 lines
815 B
Markdown
32 lines
815 B
Markdown
|
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||
|
|
|
||
|
|
[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [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
|
||
|
|
rm(name: string, host?: Host): boolean;
|
||
|
|
```
|
||
|
|
|
||
|
|
## Parameters
|
||
|
|
|
||
|
|
| Parameter | Type | Description |
|
||
|
|
| --- | --- | --- |
|
||
|
|
| name | string | Filename of file to remove. Must include the extension. |
|
||
|
|
| host | [Host](./bitburner.host.md) | Host or IP 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
|
||
|
|
|
||
|
|
1 GB
|
||
|
|
|