mirror of
https://github.com/bitburner-official/bitburner-src.git
synced 2026-04-17 06:48:42 +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>
222 lines
2.4 KiB
Markdown
222 lines
2.4 KiB
Markdown
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
|
|
[Home](./index.md) > [bitburner](./bitburner.md) > [AutocompleteData](./bitburner.autocompletedata.md)
|
|
|
|
## AutocompleteData interface
|
|
|
|
Used for autocompletion
|
|
|
|
**Signature:**
|
|
|
|
```typescript
|
|
interface AutocompleteData
|
|
```
|
|
|
|
## Properties
|
|
|
|
<table><thead><tr><th>
|
|
|
|
Property
|
|
|
|
|
|
</th><th>
|
|
|
|
Modifiers
|
|
|
|
|
|
</th><th>
|
|
|
|
Type
|
|
|
|
|
|
</th><th>
|
|
|
|
Description
|
|
|
|
|
|
</th></tr></thead>
|
|
<tbody><tr><td>
|
|
|
|
[command](./bitburner.autocompletedata.command.md)
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
</td><td>
|
|
|
|
string
|
|
|
|
|
|
</td><td>
|
|
|
|
The raw command string that you have typed until you press \[Tab\] to use the autocomplete feature.
|
|
|
|
For example, if you type `[Space]run test.js[Space][Space][Space][Press tab to use autocomplete]`<!-- -->, "command" will contain all space characters (1 space character before "run" and 3 space characters after ".js").
|
|
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
[enums](./bitburner.autocompletedata.enums.md)
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
</td><td>
|
|
|
|
[NSEnums](./bitburner.nsenums.md)
|
|
|
|
|
|
</td><td>
|
|
|
|
Netscript Enums
|
|
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
[filename](./bitburner.autocompletedata.filename.md)
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
</td><td>
|
|
|
|
string
|
|
|
|
|
|
</td><td>
|
|
|
|
The filename of the script about to be run
|
|
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
[hostname](./bitburner.autocompletedata.hostname.md)
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
</td><td>
|
|
|
|
string
|
|
|
|
|
|
</td><td>
|
|
|
|
The hostname of the server the script would be running on
|
|
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
[processes](./bitburner.autocompletedata.processes.md)
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
</td><td>
|
|
|
|
[ProcessInfo](./bitburner.processinfo.md)<!-- -->\[\]
|
|
|
|
|
|
</td><td>
|
|
|
|
The processes running on the host
|
|
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
[scripts](./bitburner.autocompletedata.scripts.md)
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
</td><td>
|
|
|
|
string\[\]
|
|
|
|
|
|
</td><td>
|
|
|
|
All scripts on the current server
|
|
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
[servers](./bitburner.autocompletedata.servers.md)
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
</td><td>
|
|
|
|
string\[\]
|
|
|
|
|
|
</td><td>
|
|
|
|
All server hostnames.
|
|
|
|
Some servers are hidden until you satisfy their requirements. This array does not contain those servers if you do not satisfy their requirements.
|
|
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
[txts](./bitburner.autocompletedata.txts.md)
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
</td><td>
|
|
|
|
string\[\]
|
|
|
|
|
|
</td><td>
|
|
|
|
All text files on the current server
|
|
|
|
|
|
</td></tr>
|
|
</tbody></table>
|
|
|
|
## Methods
|
|
|
|
<table><thead><tr><th>
|
|
|
|
Method
|
|
|
|
|
|
</th><th>
|
|
|
|
Description
|
|
|
|
|
|
</th></tr></thead>
|
|
<tbody><tr><td>
|
|
|
|
[flags(schema)](./bitburner.autocompletedata.flags.md)
|
|
|
|
|
|
</td><td>
|
|
|
|
Parses the flags schema on the already inputted flags
|
|
|
|
|
|
</td></tr>
|
|
</tbody></table>
|
|
|