EditLinksParams

Parameters for editLinks.

Import:

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

Signature:

export interface EditLinksParams extends EditLinksOptions

Extends: EditLinksOptions

Properties

Property	Type	Description
app	App	The Obsidian application instance.
offsetRange?	OffsetRange	A range within the file's content, in character offsets, restricting the pass to the links inside it. When omitted, every link is visited. A link is edited only when it is **fully contained** in the range; one that merely overlaps it is left alone, because rewriting part of a link corrupts it. Both bounds are inclusive, so a range whose offsets coincide exactly with a link's does include that link. A reference that carries no position within the file's content — a frontmatter link, a multi-link frontmatter value entry, or any canvas reference — is never in range and is skipped whenever a range is supplied. The offsets are into the content this function reads from the vault. Before reading, it saves any unsaved editor buffer for the file, so a range taken from an open editor via Editor.posToOffset is valid. The caller owns only the case where the buffer changes between computing the range and this call.
pathOrFile	PathOrFile	The path or file to edit the links for.
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:

• editLinks