mirror of
https://github.com/bitburner-official/bitburner-src.git
synced 2024-09-19 20:38:42 +02:00
27 lines
901 B
Markdown
27 lines
901 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 | `${ToastVariant}`, duration?: number | null): void;
|
|
```
|
|
|
|
## Parameters
|
|
|
|
| Parameter | Type | Description |
|
|
| --- | --- | --- |
|
|
| msg | string | Message in the toast. |
|
|
| variant | [ToastVariant](./bitburner.toastvariant.md) \| \`${[ToastVariant](./bitburner.toastvariant.md)<!-- -->}\` | _(Optional)_ Type of toast. Must be one of success, info, warning, error. Defaults to success. |
|
|
| duration | number \| null | _(Optional)_ Duration of toast in ms. Can also be <code>null</code> to create a persistent toast. Defaults to 2000. |
|
|
|
|
**Returns:**
|
|
|
|
void
|
|
|