bitburner-src/markdown/bitburner.ns.toast.md

27 lines
816 B
Markdown
Raw Normal View History

<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [NS](./bitburner.ns.md) &gt; [toast](./bitburner.ns.toast.md)
## NS.toast() method
Queue a toast (bottom-right notification).
<b>Signature:</b>
```typescript
2022-08-17 14:50:05 +02:00
toast(msg: string, variant?: ToastVariantValues, duration?: number | null): void;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
2022-08-17 14:50:05 +02:00
| msg | string | Message in the toast. |
2022-04-13 08:04:51 +02:00
| variant | [ToastVariantValues](./bitburner.toastvariantvalues.md) | Type of toast, must be one of success, info, warning, error. Defaults to success. |
2022-01-16 00:39:37 +01:00
| duration | number \| null | Duration of toast in ms. Can also be <code>null</code> to create a persistent toast. Defaults to 2000 |
<b>Returns:</b>
void