mirror of
https://github.com/bitburner-official/bitburner-src.git
synced 2024-11-29 19:13:49 +01:00
65cd14e33b
* 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.
28 lines
1.1 KiB
Markdown
28 lines
1.1 KiB
Markdown
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
|
|
[Home](./index.md) > [bitburner](./bitburner.md) > [NetscriptPort](./bitburner.netscriptport.md)
|
|
|
|
## NetscriptPort interface
|
|
|
|
Object representing a port. A port is a serialized queue.
|
|
|
|
<b>Signature:</b>
|
|
|
|
```typescript
|
|
interface NetscriptPort
|
|
```
|
|
|
|
## Methods
|
|
|
|
| Method | Description |
|
|
| --- | --- |
|
|
| [clear()](./bitburner.netscriptport.clear.md) | Empties all data from the port. |
|
|
| [empty()](./bitburner.netscriptport.empty.md) | Check if the port is empty. |
|
|
| [full()](./bitburner.netscriptport.full.md) | Check if the port is full. |
|
|
| [nextWrite()](./bitburner.netscriptport.nextwrite.md) | Sleeps until the port is written to. |
|
|
| [peek()](./bitburner.netscriptport.peek.md) | Retrieve the first element from the port without removing it. |
|
|
| [read()](./bitburner.netscriptport.read.md) | Shift an element out of the port. |
|
|
| [tryWrite(value)](./bitburner.netscriptport.trywrite.md) | Attempt to write data to the port. |
|
|
| [write(value)](./bitburner.netscriptport.write.md) | Write data to a port. |
|
|
|