work on doc

This commit is contained in:
Olivier Gagnon
2021-10-30 12:34:14 -04:00
parent f99c3fd0cd
commit 43fc5dfd48
589 changed files with 63720 additions and 1168 deletions

View File

@@ -0,0 +1,30 @@
<!-- 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
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
1 GB