felixfoertsch/bitburner-src
1
0
Fork 0
mirror of https://github.com/bitburner-official/bitburner-src.git synced 2026-04-21 16:52:55 +02:00
Code Issues Packages Projects Releases Wiki Activity

work on making the netscript api tighter

Browse Source
This commit is contained in:
Olivier Gagnon
2021-11-03 20:19:52 -04:00
parent c5fb5155f3
commit 14150d3e33
270 changed files with 11011 additions and 1273 deletions
Download Patch File Download Diff File Expand all files Collapse all files
markdown/bitburner.ns.read.md
+4 -6
View File
@@ -9,18 +9,18 @@ Read content of a file.
<b>Signature:</b>
```typescript
read(handle: string | number): string | number | object;
read(handle: string): any;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| handle | string \| number | Port or text file to read from. |
| handle | string | Port or text file to read from. |
<b>Returns:</b>
string \| number \| object
any
Data in the specified text file or port.
@@ -30,7 +30,5 @@ RAM cost: 1 GB
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.
This function will return the data in the specified text file. If the text file does not exist, an empty string will be returned.