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

87
markdown/bitburner.ns.exec.md
View File

@@ -14,12 +14,87 @@ exec(script: string, host: string, threadOrOptions?: number | RunOptions, ...arg
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| script | string | Filename of script to execute. This file must already exist on the target server. |
| host | string | Hostname/IP of the <code>target server</code> on which to execute the script. |
| threadOrOptions | number \| [RunOptions](./bitburner.runoptions.md) | _(Optional)_ Either an integer number of threads for new script, or a [RunOptions](./bitburner.runoptions.md) object. Threads defaults to 1. |
| args | [ScriptArg](./bitburner.scriptarg.md)<!-- -->\[\] | Additional arguments to pass into the new script that is being run. Note that if any arguments are being passed into the new script, then the third argument threadOrOptions must be filled in with a value. |
<table><thead><tr><th>
Parameter
</th><th>
Type
</th><th>
Description
</th></tr></thead>
<tbody><tr><td>
script
</td><td>
string
</td><td>
Filename of script to execute. This file must already exist on the target server.
</td></tr>
<tr><td>
host
</td><td>
string
</td><td>
Hostname/IP of the `target server` on which to execute the script.
</td></tr>
<tr><td>
threadOrOptions
</td><td>
number \| [RunOptions](./bitburner.runoptions.md)
</td><td>
_(Optional)_ Either an integer number of threads for new script, or a [RunOptions](./bitburner.runoptions.md) object. Threads defaults to 1.
</td></tr>
<tr><td>
args
</td><td>
[ScriptArg](./bitburner.scriptarg.md)<!-- -->\[\]
</td><td>
Additional arguments to pass into the new script that is being run. Note that if any arguments are being passed into the new script, then the third argument threadOrOptions must be filled in with a value.
</td></tr>
</tbody></table>
**Returns:**