mirror of
https://github.com/bitburner-official/bitburner-src.git
synced 2024-11-10 09:43:54 +01:00
33 lines
784 B
Markdown
33 lines
784 B
Markdown
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
|
|
[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [readPort](./bitburner.ns.readport.md)
|
|
|
|
## NS.readPort() method
|
|
|
|
Read data from a port.
|
|
|
|
**Signature:**
|
|
|
|
```typescript
|
|
readPort(portNumber: number): PortData;
|
|
```
|
|
|
|
## Parameters
|
|
|
|
| Parameter | Type | Description |
|
|
| --- | --- | --- |
|
|
| portNumber | number | Port to read from. Must be a positive integer. |
|
|
|
|
**Returns:**
|
|
|
|
[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.
|
|
|