RetryWithTimeoutNoticeParams
Options for retryWithTimeoutNotice.
Import:
import type { RetryWithTimeoutNoticeParams } from 'obsidian-dev-utils/obsidian/async-with-notice';Signature:
export interface RetryWithTimeoutNoticeParamsProperties
| Property | Type | Description |
|---|---|---|
| content? | ValueProvider<DocumentFragment | string> | Custom content to show in the notice instead of the default timed-out message. Resolved only if the operation exceeds the timeout, shown as a permanent notice, and hidden when the operation completes. |
| operationName? | string | The name of the operation. |
| pluginNoticeComponent | null | PluginNoticeComponent | Plugin notice component used to show the timeout notice. When null (or shouldShowTimeoutNotice is false), no notice is shown and the timeout is only logged. |
| retryOptions? | RetryOptions | The retry options. |
| shouldShowTimeoutNotice? | boolean | Whether to show a timeout notice. |
| stackTrace? | string | The stack trace of the source function. |
Methods
| Method | Returns | Description |
|---|---|---|
| operationFunction(this, abortSignal) | Promisable<boolean> | The operation function to execute. |
Links to this page: