bitburner-src/markdown/bitburner.ns.write.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

1.2 KiB

Home > bitburner > NS > write

NS.write() method

Write data to a file.

Signature:

write(filename: string, data?: string, mode?: "w" | "a"): void;

Parameters

Parameter Type Description
filename string Name of the file to be written to.
data string Data to write.
mode "w" | "a" Defines the write mode.

Returns:

void

Remarks

RAM cost: 0 GB

This function can be used to write data to a text file (.txt) or a script (.js or .script).

This function will write data to that file. If the specified file does not exist, then it will be created. The third argument mode defines how the data will be written to the file. If mode is set to “w”, then the data is written in “write” mode which means that it will overwrite all existing data on the file. If mode is set to any other value then the data will be written in “append” mode which means that the data will be added at the end of the file.