bitburner-src/markdown/bitburner.ns.read.md
Snarling 08e71c732b
Threads are a positive integer (#366)
* Added new positive integer ns validation helper
* `run`, `exec`, and `spawn` verify threads as a positive integer.
* `run` terminal command also fails if the provided threadcount is not a positive integer.
* Removed some references to .script files in various documentation, and removed some of the NS1 example blocks
2023-02-14 01:32:01 -05:00

35 lines
733 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.
**Signature:**
```typescript
read(filename: string): string;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| filename | string | Name of the file to be read. |
**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) or script (.js or .script).
This function will return the data in the specified file. If the file does not exist, an empty string will be returned.