mirror of
https://github.com/bitburner-official/bitburner-src.git
synced 2026-04-17 14:59:16 +02:00
dcd2f33f7c
* Update api-documentor and api-extractor. #1566 follow-up.
I have verified that the HTML/markdown table generation bug in
[#4878](https://github.com/microsoft/rushstack/issues/4878) in rushstack
for api-documentor has been fixed as per rushstack#5256. The testcase
[repro](https://github.com/catloversg/api-documenter-bug-pr-4578) now
produces the correct expected output.
I have confirmed that the generated output in bitburner from
`npm run doc` now generated HTML tables, and correctly inserts
a blank line between the </table> and the follow line (e.g. Returns).
Stylisticly it could use some whitespace, but it is correctly rendered.
This commit is only the updated packages, not the updated generated
documentation. I assume that is automatically generated by the GitHub
workflow.
* Follow up to 5f732a6f35, include `npm run doc` changed docs.
* Add missing license info
* Fix React warning
---------
Co-authored-by: CatLover <152669316+catloversg@users.noreply.github.com>
118 lines
1.4 KiB
Markdown
118 lines
1.4 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.
|
|
|
|
**Signature:**
|
|
|
|
```typescript
|
|
export interface NetscriptPort
|
|
```
|
|
|
|
## Methods
|
|
|
|
<table><thead><tr><th>
|
|
|
|
Method
|
|
|
|
|
|
</th><th>
|
|
|
|
Description
|
|
|
|
|
|
</th></tr></thead>
|
|
<tbody><tr><td>
|
|
|
|
[clear()](./bitburner.netscriptport.clear.md)
|
|
|
|
|
|
</td><td>
|
|
|
|
Empties all data from the port.
|
|
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
[empty()](./bitburner.netscriptport.empty.md)
|
|
|
|
|
|
</td><td>
|
|
|
|
Check if the port is empty.
|
|
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
[full()](./bitburner.netscriptport.full.md)
|
|
|
|
|
|
</td><td>
|
|
|
|
Check if the port is full.
|
|
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
[nextWrite()](./bitburner.netscriptport.nextwrite.md)
|
|
|
|
|
|
</td><td>
|
|
|
|
Waits until the port is written to.
|
|
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
[peek()](./bitburner.netscriptport.peek.md)
|
|
|
|
|
|
</td><td>
|
|
|
|
Retrieve the first element from the port without removing it.
|
|
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
[read()](./bitburner.netscriptport.read.md)
|
|
|
|
|
|
</td><td>
|
|
|
|
Shift an element out of the port.
|
|
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
[tryWrite(value)](./bitburner.netscriptport.trywrite.md)
|
|
|
|
|
|
</td><td>
|
|
|
|
Attempt to write data to the port.
|
|
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
[write(value)](./bitburner.netscriptport.write.md)
|
|
|
|
|
|
</td><td>
|
|
|
|
Write data to a port.
|
|
|
|
|
|
</td></tr>
|
|
</tbody></table>
|
|
|