bitburner-src/markdown/bitburner.ns.peek.md
Olivier Gagnon d82f3e7ad7 more doc
2021-11-03 00:33:14 -04:00

762 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: number): string | number | object;

Parameters

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

Returns:

string | number | object

Data in the specified port.

Remarks

RAM cost: 1 GB