mirror of
https://github.com/bitburner-official/bitburner-src.git
synced 2024-11-18 13:43:49 +01:00
35 lines
1.1 KiB
Markdown
35 lines
1.1 KiB
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
|
||
|
|
|
||
|
|
This function is used to read data from a port or from a text file (.txt).
|
||
|
|
|
||
|
|
If the argument port/fn is a number between 1 and 20, then it specifies a port and it will read data from that port. A port is a serialized queue. This function will remove the first element from that queue and return it. If the queue is empty, then the string “NULL PORT DATA” will be returned.
|
||
|
|
|
||
|
|
If the argument port/fn is a string, then it specifies the name of a text file (.txt) and this function will return the data in the specified text file. If the text file does not exist, an empty string will be returned.
|
||
|
|
|
||
|
|
<b>Signature:</b>
|
||
|
|
|
||
|
|
```typescript
|
||
|
|
read(handle: Handle): string | number | object;
|
||
|
|
```
|
||
|
|
|
||
|
|
## Parameters
|
||
|
|
|
||
|
|
| Parameter | Type | Description |
|
||
|
|
| --- | --- | --- |
|
||
|
|
| handle | [Handle](./bitburner.handle.md) | Port or text file to read from. |
|
||
|
|
|
||
|
|
<b>Returns:</b>
|
||
|
|
|
||
|
|
string \| number \| object
|
||
|
|
|
||
|
|
Data in the specified text file or port.
|
||
|
|
|
||
|
|
## Remarks
|
||
|
|
|
||
|
|
1 GB
|
||
|
|
|