bitburner-src/markdown/bitburner.ns.peek.md
T.J. Eckman 33f0150d25
BUGFIX: Memory Leak in NetscriptPorts (#399)
Co-authored-by: Snarling <84951833+Snarling@users.noreply.github.com>
2023-02-27 19:54:04 -05:00

817 B

Home > bitburner > NS > peek

NS.peek() method

Get a copy of the data from a port without popping it.

Signature:

peek(portNumber: number): PortData;

Parameters

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

Returns:

PortData

Data in the specified port.

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.