PIPE: Add pipe support for passing data into and out of terminal commands (#2395)

This commit is contained in:
Michael Ficocelli
2026-02-22 12:18:23 -07:00
committed by GitHub
parent 4a22e16058
commit 92b8b58588
68 changed files with 2430 additions and 480 deletions

View File

@@ -0,0 +1,23 @@
<!-- 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; [getStdin](./bitburner.ns.getstdin.md)
## NS.getStdin() method
Retrieves the NetscriptPort handle used to get input piped to the script. Examples:
If a script was run with data piped into it via the terminal: `echo input1 | run myScript.js`
then `ns.getStdin().read()` inside `myScript.js` would return `"input1"`<!-- -->.
If more data is added later (for example, if one script's terminal is piped to another script), then the script can read that data from `ns.getStdin()` as well. `await ns.getStdin().nextPortWrite()` can be used to wait until new data is available to read.
**Signature:**
```typescript
getStdin(): NetscriptPort | null;
```
**Returns:**
[NetscriptPort](./bitburner.netscriptport.md) \| null

View File

@@ -1051,6 +1051,23 @@ Get the used RAM on a server.
Share power has a multiplicative effect on rep/second while doing work for a faction. Share power increases incrementally for every thread of share running on your server network, but at a sharply decreasing rate.
</td></tr>
<tr><td>
[getStdin()](./bitburner.ns.getstdin.md)
</td><td>
Retrieves the NetscriptPort handle used to get input piped to the script. Examples:
If a script was run with data piped into it via the terminal: `echo input1 | run myScript.js`
then `ns.getStdin().read()` inside `myScript.js` would return `"input1"`<!-- -->.
If more data is added later (for example, if one script's terminal is piped to another script), then the script can read that data from `ns.getStdin()` as well. `await ns.getStdin().nextPortWrite()` can be used to wait until new data is available to read.
</td></tr>
<tr><td>