bitburner-src/markdown/bitburner.ns.peek.md
Olivier Gagnon 43fc5dfd48 work on doc
2021-10-30 12:34:14 -04:00

771 B

Home > bitburner > NS > peek

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.

Signature:

peek(port: Port): string | number | object;

Parameters

Parameter Type Description
port Port Port to peek. Must be an integer between 1 and 20.

Returns:

string | number | object

Data in the specified port.

Remarks

1 GB