mirror of
https://github.com/bitburner-official/bitburner-src.git
synced 2026-04-16 06:18:42 +02:00
67 lines
968 B
Markdown
67 lines
968 B
Markdown
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
|
|
[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [read](./bitburner.ns.read.md)
|
|
|
|
## NS.read() method
|
|
|
|
Read content of a file.
|
|
|
|
**Signature:**
|
|
|
|
```typescript
|
|
read(filename: string): string;
|
|
```
|
|
|
|
## Parameters
|
|
|
|
<table><thead><tr><th>
|
|
|
|
Parameter
|
|
|
|
|
|
</th><th>
|
|
|
|
Type
|
|
|
|
|
|
</th><th>
|
|
|
|
Description
|
|
|
|
|
|
</th></tr></thead>
|
|
<tbody><tr><td>
|
|
|
|
filename
|
|
|
|
|
|
</td><td>
|
|
|
|
string
|
|
|
|
|
|
</td><td>
|
|
|
|
Name of the file to be read.
|
|
|
|
|
|
</td></tr>
|
|
</tbody></table>
|
|
|
|
**Returns:**
|
|
|
|
string
|
|
|
|
Data in the specified text file.
|
|
|
|
## Remarks
|
|
|
|
RAM cost: 0 GB
|
|
|
|
This function is used to read data from a text file (.txt, .json, .css), a script (.js, .jsx, .ts, .tsx), a literature file (.lit), or a message (.msg).
|
|
|
|
This function will return the data in the specified file. If the file does not exist, an empty string will be returned.
|
|
|
|
With literature files, the returned data is a raw HTML string.
|
|
|