RunWithTimeoutNoticeParams<Result>
Options for runWithTimeout.
Import:
import type { RunWithTimeoutNoticeParams } from '@mnaoumov/obsidian-lib/async-with-notice';Signature:
export interface RunWithTimeoutNoticeParams<Result>Properties
| 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 RunWithTimeoutNoticeParams.timeoutInMilliseconds, shown as a permanent notice, and hidden when the operation completes. |
| context? | unknown | The context of the function. |
| operationFunction | (abortSignal: AbortSignal) => Promisable<Result> | The operation function to execute. |
| 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. |
| shouldShowTimeoutNotice? | boolean | Whether to show a timeout notice. |
| stackTrace? | string | The stack trace of the source function. |
| timeoutInMilliseconds | number | The maximum time to wait in milliseconds. |
Links to this page: