bitburner-src/markdown/bitburner.ns.rm.md
Snarling 65cd14e33b
DOC: Add ns documentation for possible sleeve tasks (#217)
* Add specific types for sleeve tasks
* Moved LocationName enum to overall enums file
* Add LocationName enum to those provided to player
* remove trailing s on CompanyPosNames enum (now CompanyPosName, in line with LocationName)
* Also regenerated all ns documentation. This leads to an expected error when checking for generated files, because PRs should not normally touch markdown files. Also leads to a lint failure in generated file bitburner.d.ts
* also removed some exporting from NetscriptDefinitions.d.ts for anything that wasn't imported somewhere else.
2022-11-20 12:07:22 -05:00

812 B

Home > bitburner > NS > rm

NS.rm() method

Delete a file.

Signature:

rm(name: string, host?: string): boolean;

Parameters

Parameter Type Description
name string Filename of file to remove. Must include the extension.
host string Hostname of the server on which to delete the file. Optional. Defaults to current server.

Returns:

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.