ConvertLinkParams

Import:

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

Signature:

export interface ConvertLinkParams

Properties

Property	Type	Description
app	App	An Obsidian app instance.
isEmptyEmbedAliasAllowed?	boolean	Whether to allow an empty alias for embeds. Applicable only if the result link style is `LinkStyle.Markdown`. If `true`: `![](foo.png)`. If `false`: `![foo](foo.png)`.
link	Reference	A reference for the link.
linkPathStyle?	LinkPathStyle	A style of the link path.
linkStyle?	LinkStyle	A style of the link.
newSourcePathOrFile	PathOrFile	A source file containing the link.
oldSourcePathOrFile?	PathOrFile	An old path of the link.
shouldEscapeAlias?	boolean	Whether to escape the alias. Applicable only if the result link style is `LinkStyle.Markdown`. If `true`: `[\\alias\\](link.md)`. If `false`: `[alias](link.md)`.
shouldIncludeAttachmentExtensionToEmbedAlias?	boolean	Whether to include the attachment extension in the embed alias. Applicable only if `isEmptyEmbedAliasAllowed` is `false`. If `true`: `[foo.png](foo.png)`. If `false`: `[foo](foo.png)`.
shouldUpdateFileNameAlias?	boolean	Whether to update file name alias.
shouldUseAngleBrackets?	boolean	Indicates if the link should use angle brackets. Applicable only if `linkStyle` is `LinkStyle.Markdown`. If `true`: `[alias](<path with spaces.md>)`. If `false`: `[alias](path%20with%20spaces.md)`.
shouldUseLeadingDotForRelativePaths?	boolean	Indicates if the link should use a leading dot. Applicable only if `linkPathStyle` is `LinkPathStyle.RelativePathToTheSource`. If `true`: `[[./relative/path/to/target]]` If `false`: `[[relative/path/to/target]]`
shouldUseLeadingSlashForAbsolutePaths?	boolean	Indicates if the link should use a leading slash. Applicable only if `linkPathStyle` is `LinkPathStyle.AbsolutePathInVault`. If `true`: `[[/absolute/path/to/target]]` If `false`: `[[absolute/path/to/target]]`

Links to this page:

convertLink