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

35 lines
743 B
Markdown
Raw Normal View History

2021-10-30 12:34:14 -04: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; [read](./bitburner.ns.read.md)
## NS.read() method
Read content of a file.
2021-10-30 12:34:14 -04:00
<b>Signature:</b>
```typescript
2022-08-17 08:50:05 -04:00
read(handle: string): PortData;
2021-10-30 12:34:14 -04:00
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
2022-01-15 18:39:37 -05:00
| handle | string | Filename to read from. |
2021-10-30 12:34:14 -04:00
<b>Returns:</b>
2022-08-17 08:50:05 -04:00
[PortData](./bitburner.portdata.md)
2021-10-30 12:34:14 -04:00
2022-01-15 18:39:37 -05:00
Data in the specified text file.
2021-10-30 12:34:14 -04:00
## Remarks
RAM cost: 0 GB
2021-10-30 12:34:14 -04:00
2022-01-15 18:39:37 -05:00
This function is used to read data from a text file (.txt).
This function will return the data in the specified text file. If the text file does not exist, an empty string will be returned.