bitburner-src/markdown/bitburner.ns.read.md
omuretsu 06a985bdf8 Revert "Remove markdown from git tracking (#139)"
This reverts commit bbb6e3f309935aebac74ddb1fbeec12dfb7540b1.
2022-10-21 11:16:00 -04:00

35 lines
737 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(filename: string): string;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| filename | string | Name of the file to be read. |
<b>Returns:</b>
string
Data in the specified text file.
## Remarks
RAM cost: 0 GB
This function is used to read data from a text file (.txt) or script (.script, .js).
This function will return the data in the specified file. If the file does not exist, an empty string will be returned.