bitburner-src/markdown/bitburner.ns.readport.md
Snarling 65cd14e33b
DOC: Add ns documentation for possible sleeve tasks (#217)
* Add specific types for sleeve tasks
* Moved LocationName enum to overall enums file
* Add LocationName enum to those provided to player
* remove trailing s on CompanyPosNames enum (now CompanyPosName, in line with LocationName)
* Also regenerated all ns documentation. This leads to an expected error when checking for generated files, because PRs should not normally touch markdown files. Also leads to a lint failure in generated file bitburner.d.ts
* also removed some exporting from NetscriptDefinitions.d.ts for anything that wasn't imported somewhere else.
2022-11-20 12:07:22 -05:00

33 lines
732 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; [readPort](./bitburner.ns.readport.md)
## NS.readPort() method
Read data from a port.
<b>Signature:</b>
```typescript
readPort(port: number): PortData;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| port | number | |
<b>Returns:</b>
[PortData](./bitburner.portdata.md)
The data read.
## Remarks
RAM cost: 0 GB
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.