mirror of
https://github.com/bitburner-official/bitburner-src.git
synced 2024-12-21 13:45:44 +01:00
26 lines
678 B
Markdown
26 lines
678 B
Markdown
|
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||
|
|
|
||
|
|
[Home](./index.md) > [bitburner](./bitburner.md) > [NetscriptPort](./bitburner.netscriptport.md) > [peek](./bitburner.netscriptport.peek.md)
|
||
|
|
|
||
|
|
## NetscriptPort.peek() method
|
||
|
|
|
||
|
|
Retrieve the first element from the port without removing it.
|
||
|
|
|
||
|
|
<b>Signature:</b>
|
||
|
|
|
||
|
|
```typescript
|
||
|
|
peek(): string | number;
|
||
|
|
```
|
||
|
|
<b>Returns:</b>
|
||
|
|
|
||
|
|
string \| number
|
||
|
|
|
||
|
|
the data read
|
||
|
|
|
||
|
|
## 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.
|
||
|
|
|