UpdateFileUrlLinksInFileParams
Params for updateFileUrlLinksInFile.
Import:
import type { UpdateFileUrlLinksInFileParams } from 'obsidian-dev-utils/obsidian/link';Signature:
export interface UpdateFileUrlLinksInFileParams extends ProcessOptionsExtends: ProcessOptions
Properties
| Property | Type | Description |
|---|---|---|
| app | App | An Obsidian app instance. |
| pathOrFile | PathOrFile | The path or file to normalize the file:// links in. |
| pluginNoticeComponent | null | PluginNoticeComponent | Plugin notice component used to show the timeout notice. When null, no timeout notice is shown regardless of ProcessOptions.shouldShowTimeoutNotice; the timeout is only logged.(Inherited from ProcessOptions) |
| resourceLockComponent | null | ResourceLockComponent | An 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. (Inherited from ProcessOptions) |
| shouldFailOnMissingFile? | boolean | Whether to fail if the file is missing or deleted. (Inherited from ProcessOptions) |
| shouldShowTimeoutNotice? | boolean | Whether to show a timeout notice. (Inherited from ProcessOptions) |
| shouldUseAngleBrackets? | boolean | Whether to emit the normalized links with angle brackets and raw spaces instead of %20-encoding. |
Links to this page: