felixfoertsch/bitburner-src
1
0
Fork 0
mirror of https://github.com/bitburner-official/bitburner-src.git synced 2026-04-17 14:59:16 +02:00
Code Issues Packages Projects Releases Wiki Activity

CODEBASE: Update api-documentor and api-extractor (#2320)

Browse Source 
* 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>
This commit is contained in:
Michael Taylor
2025-09-26 18:52:39 -03:00
committed by GitHub
parent 09ecd915c2
commit dcd2f33f7c
498 changed files with 41426 additions and 3561 deletions
Download Patch File Download Diff File Expand all files Collapse all files

110
markdown/bitburner.netscriptport.md
View File

@@ -14,14 +14,104 @@ export 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) | Waits 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. |
<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>