bitburner-src/markdown/bitburner.netscriptport.md
Snarling 65cd14e33b
DOC: Add ns documentation for possible sleeve tasks (#217)
* Add specific types for sleeve tasks
* Moved LocationName enum to overall enums file
* Add LocationName enum to those provided to player
* remove trailing s on CompanyPosNames enum (now CompanyPosName, in line with LocationName)
* Also regenerated all ns documentation. This leads to an expected error when checking for generated files, because PRs should not normally touch markdown files. Also leads to a lint failure in generated file bitburner.d.ts
* also removed some exporting from NetscriptDefinitions.d.ts for anything that wasn't imported somewhere else.
2022-11-20 12:07:22 -05:00

1.1 KiB

Home > bitburner > NetscriptPort

NetscriptPort interface

Object representing a port. A port is a serialized queue.

Signature:

interface NetscriptPort 

Methods

Method Description
clear() Empties all data from the port.
empty() Check if the port is empty.
full() Check if the port is full.
nextWrite() Sleeps until the port is written to.
peek() Retrieve the first element from the port without removing it.
read() Shift an element out of the port.
tryWrite(value) Attempt to write data to the port.
write(value) Write data to a port.