mirror of
https://github.com/bitburner-official/bitburner-src.git
synced 2026-04-26 11:10:58 +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>
87 lines
993 B
Markdown
87 lines
993 B
Markdown
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
|
|
[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [toast](./bitburner.ns.toast.md)
|
|
|
|
## NS.toast() method
|
|
|
|
Queue a toast (bottom-right notification).
|
|
|
|
**Signature:**
|
|
|
|
```typescript
|
|
toast(msg: string, variant?: ToastVariant, duration?: number | null): void;
|
|
```
|
|
|
|
## Parameters
|
|
|
|
<table><thead><tr><th>
|
|
|
|
Parameter
|
|
|
|
|
|
</th><th>
|
|
|
|
Type
|
|
|
|
|
|
</th><th>
|
|
|
|
Description
|
|
|
|
|
|
</th></tr></thead>
|
|
<tbody><tr><td>
|
|
|
|
msg
|
|
|
|
|
|
</td><td>
|
|
|
|
string
|
|
|
|
|
|
</td><td>
|
|
|
|
Message in the toast.
|
|
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
variant
|
|
|
|
|
|
</td><td>
|
|
|
|
[ToastVariant](./bitburner.toastvariant.md)
|
|
|
|
|
|
</td><td>
|
|
|
|
_(Optional)_ Type of toast. Must be one of success, info, warning, error. Defaults to success.
|
|
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
duration
|
|
|
|
|
|
</td><td>
|
|
|
|
number \| null
|
|
|
|
|
|
</td><td>
|
|
|
|
_(Optional)_ Duration of toast in ms. Can also be `null` to create a persistent toast. Defaults to 2000.
|
|
|
|
|
|
</td></tr>
|
|
</tbody></table>
|
|
|
|
**Returns:**
|
|
|
|
void
|
|
|