mirror of
https://github.com/bitburner-official/bitburner-src.git
synced 2024-11-18 13:43:49 +01:00
31 lines
781 B
Markdown
31 lines
781 B
Markdown
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
|
|
[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [peek](./bitburner.ns.peek.md)
|
|
|
|
## NS.peek() method
|
|
|
|
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.
|
|
|
|
<b>Signature:</b>
|
|
|
|
```typescript
|
|
peek(port: Port): string | number | object;
|
|
```
|
|
|
|
## Parameters
|
|
|
|
| Parameter | Type | Description |
|
|
| --- | --- | --- |
|
|
| port | [Port](./bitburner.port.md) | Port to peek. Must be an integer between 1 and 20. |
|
|
|
|
<b>Returns:</b>
|
|
|
|
string \| number \| object
|
|
|
|
Data in the specified port.
|
|
|
|
## Remarks
|
|
|
|
RAM cost: 1 GB
|
|
|