bitburner-src/markdown/bitburner.ns.read.md
Olivier Gagnon 3217f53717 doc
2022-08-17 08:50:05 -04:00

35 lines
743 B
Markdown

<!-- 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.
<b>Signature:</b>
```typescript
read(handle: string): PortData;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| handle | string | Filename to read from. |
<b>Returns:</b>
[PortData](./bitburner.portdata.md)
Data in the specified text file.
## Remarks
RAM cost: 0 GB
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.