Skip to content

UpdateLinkParams

Params for updateLink.

Import:

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

Signature:

export interface UpdateLinkParams

Properties

PropertyTypeDescription
appAppAn Obsidian app instance.
linkReferenceA reference for the link.
linkStyle?LinkStyleWhether to force markdown links.
newSourcePathOrFilePathOrFileA source file containing the link.
newTargetPathOrFilePathOrFileA file associated with the link.
oldSourcePathOrFile?PathOrFileAn old source file containing the link.
oldTargetPathOrFile?PathOrFileAn old path of the file.
shouldUpdateFileNameAlias?booleanWhether to update file name alias.

Links to this page: