Skip to content

ProcessOptions

Options for process.

Import:

import type { ProcessOptions } from '@mnaoumov/obsidian-lib/vault';

Signature:

export interface ProcessOptions extends RetryOptions

Extends: RetryOptions

Properties

PropertyTypeDescription
pluginNoticeComponentnull | PluginNoticeComponentPlugin notice component used to show the timeout notice. When null, no timeout notice is shown regardless of ProcessOptions.shouldShowTimeoutNotice; the timeout is only logged.
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.
shouldFailOnMissingFile?booleanWhether to fail if the file is missing or deleted.
shouldShowTimeoutNotice?booleanWhether to show a timeout notice.

Links to this page: