mirror of
https://github.com/bitburner-official/bitburner-src.git
synced 2026-04-21 00:32:51 +02:00
Michael Taylor
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>
111 lines
1.9 KiB
Markdown
111 lines
1.9 KiB
Markdown
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||
|
||
[Home](./index.md) > [bitburner](./bitburner.md) > [UserInterface](./bitburner.userinterface.md) > [openTail](./bitburner.userinterface.opentail.md)
|
||
|
||
## UserInterface.openTail() method
|
||
|
||
Open the tail window of a script.
|
||
|
||
**Signature:**
|
||
|
||
```typescript
|
||
openTail(fn?: FilenameOrPID, host?: string, ...args: ScriptArg[]): void;
|
||
```
|
||
|
||
## Parameters
|
||
|
||
<table><thead><tr><th>
|
||
|
||
Parameter
|
||
|
||
|
||
</th><th>
|
||
|
||
Type
|
||
|
||
|
||
</th><th>
|
||
|
||
Description
|
||
|
||
|
||
</th></tr></thead>
|
||
<tbody><tr><td>
|
||
|
||
fn
|
||
|
||
|
||
</td><td>
|
||
|
||
[FilenameOrPID](./bitburner.filenameorpid.md)
|
||
|
||
|
||
</td><td>
|
||
|
||
_(Optional)_ Optional. Filename or PID of the script being tailed. If omitted, the current script is tailed.
|
||
|
||
|
||
</td></tr>
|
||
<tr><td>
|
||
|
||
host
|
||
|
||
|
||
</td><td>
|
||
|
||
string
|
||
|
||
|
||
</td><td>
|
||
|
||
_(Optional)_ Optional. Hostname/IP of the script being tailed. Defaults to the server this script is running on. If args are specified, this is not optional.
|
||
|
||
|
||
</td></tr>
|
||
<tr><td>
|
||
|
||
args
|
||
|
||
|
||
</td><td>
|
||
|
||
[ScriptArg](./bitburner.scriptarg.md)<!-- -->\[\]
|
||
|
||
|
||
</td><td>
|
||
|
||
Arguments for the script being tailed.
|
||
|
||
|
||
</td></tr>
|
||
</tbody></table>
|
||
|
||
**Returns:**
|
||
|
||
void
|
||
|
||
## Remarks
|
||
|
||
RAM cost: 0 GB
|
||
|
||
Opens a script’s logs. This is functionally the same as the tail Terminal command.
|
||
|
||
If the function is called with no arguments, it will open the current script’s logs.
|
||
|
||
Otherwise, the PID or filename, hostname/ip, and args… arguments can be used to get the logs from another script. Remember that scripts are uniquely identified by both their names and arguments.
|
||
|
||
## Example
|
||
|
||
|
||
```js
|
||
//Open logs from foo.js on the current server that was run with no args
|
||
ns.ui.openTail("foo.js");
|
||
|
||
//Get logs from foo.js on the foodnstuff server that was run with no args
|
||
ns.ui.openTail("foo.js", "foodnstuff");
|
||
|
||
//Get logs from foo.js on the foodnstuff server that was run with the arguments [1, "test"]
|
||
ns.ui.openTail("foo.js", "foodnstuff", 1, "test");
|
||
```
|
||
|