Skip to content

RetryWithTimeoutNoticeParams

Options for retryWithTimeoutNotice.

Import:

import type { RetryWithTimeoutNoticeParams } from 'obsidian-dev-utils/obsidian/async-with-notice';

Signature:

export interface RetryWithTimeoutNoticeParams

Properties

PropertyTypeDescription
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?stringThe name of the operation.
pluginNoticeComponentPluginNoticeComponentPlugin notice component to show notices.
retryOptions?RetryOptionsThe retry options.
shouldShowTimeoutNotice?booleanWhether to show a timeout notice.
stackTrace?stringThe stack trace of the source function.

Methods

MethodReturnsDescription
operationFn(this, abortSignal)Promisable<boolean>The operation function to execute.

Links to this page: