EditLinksInContentParams

Parameters for editLinksInContent.

Import:

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

Signature:

export interface EditLinksInContentParams

Properties

Property	Type	Description
abortSignal?	AbortSignal	The abort signal to control the execution of the function.
app	App	The Obsidian application instance.
content	string	The content to edit the links in.
shouldEditExternalLinks?	boolean	Whether to also edit external links parsed from the note body. When true, the converter also receives references for external links.
shouldEditFrontmatterExternalLinks?	boolean	Whether to also edit external links parsed from frontmatter values. When true, the converter also receives references for frontmatter external links.
shouldEditMultiValueFrontmatterExternalLinks?	boolean	Whether to also edit external links parsed from multi-link (multi-value) frontmatter values. When true, the converter also receives references for each external link within a multi-link frontmatter value (each located by its offsets, so only that link is spliced back in place).

Methods

Method	Returns	Description
linkConverter(this, link)	Promisable<MaybeReturn<string>>	The function that converts each link.

---

Links to this page:

• editLinksInContent