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

35 lines
1.5 KiB
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; [write](./bitburner.ns.write.md)
## NS.write() method
This function can be used to either write data to a port or to a text file (.txt).
If the first argument is a number between 1 and 20, then it specifies a port and this function will write data to that port. The third argument, mode, is not used when writing to a port.
If the first argument is a string, then it specifies the name of a text file (.txt) and this function will write data to that text file. If the specified text file does not exist, then it will be created. The third argument mode, defines how the data will be written to the text 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 text 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 text file.
<b>Signature:</b>
```typescript
2021-11-03 05:33:14 +01:00
write(handle: string | number, data?: string[] | number, mode?: "w" | "a"): void;
2021-10-30 18:34:14 +02:00
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
2021-11-03 05:33:14 +01:00
| handle | string \| number | Port or text file that will be written to. |
2021-11-03 05:27:21 +01:00
| data | string\[\] \| number | Data to write. |
2021-10-30 18:34:14 +02:00
| mode | "w" \| "a" | Defines the write mode. Only valid when writing to text files. |
<b>Returns:</b>
void
## Remarks
2021-10-30 21:46:34 +02:00
RAM cost: 1 GB
2021-10-30 18:34:14 +02:00