Skip to content

ProcessOptions

Options for process.

Import:

import type { ProcessOptions } from 'obsidian-dev-utils/obsidian/vault';

Signature:

export interface ProcessOptions extends RetryOptions

Extends: RetryOptions

Properties

PropertyTypeDescription
abortSignal?AbortSignalA abort signal to cancel the retry operation.
(Inherited from RetryOptions)
resourceLockComponentnull | ResourceLockComponentAn resource-lock component used to lock the file's editor read-only for the duration of processing. The lock is reference-counted, so it composes with any outer operation-level lock on the same note.
retryDelayInMilliseconds?numberA delay in milliseconds between retry attempts.
(Inherited from RetryOptions)
shouldFailOnMissingFile?booleanWhether to fail if the file is missing or deleted.
shouldRetryOnError?booleanWhether to retry the function on error.
(Inherited from RetryOptions)
shouldShowTimeoutNotice?booleanWhether to show a timeout notice.
timeoutInMilliseconds?numberA maximum time in milliseconds to wait before giving up on retrying.
(Inherited from RetryOptions)

Links to this page: