UpdateLinksInFileParams

Params for updateLinksInFile.

Import:

import type { UpdateLinksInFileParams } from 'obsidian-dev-utils/obsidian/link';

Signature:

export interface UpdateLinksInFileParams extends ProcessOptions

Extends: ProcessOptions

Properties

Property	Type	Description
app	App	An Obsidian app instance.
linkPathStyle?	LinkPathStyle	A style of the link path.
linkStyle?	LinkStyle	A style of the link.
newSourcePathOrFile	PathOrFile	A file to update the links in.
oldSourcePathOrFile?	PathOrFile	An old path of the file.
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)
shouldUpdateEmbedOnlyLinks?	boolean	Whether to update only embedded links.
shouldUpdateFileNameAlias?	boolean	Whether to update file name alias.

---

Links to this page:

• updateLinksInFile