bitburner-src/markdown/bitburner.ns.peek.md
omuretsu 06a985bdf8 Revert "Remove markdown from git tracking (#139)"
This reverts commit bbb6e3f309935aebac74ddb1fbeec12dfb7540b1.
2022-10-21 11:16:00 -04:00

33 lines
811 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; [peek](./bitburner.ns.peek.md)
## NS.peek() method
Get a copy of the data from a port without popping it.
<b>Signature:</b>
```typescript
peek(port: number): PortData;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| port | number | Port to peek. Must be an integer between 1 and 20. |
<b>Returns:</b>
[PortData](./bitburner.portdata.md)
Data in the specified port.
## Remarks
RAM cost: 0 GB
This function is used to peek at the data from a port. It returns the first element in the specified port without removing that element. If the port is empty, the string “NULL PORT DATA” will be returned.