Skip to content

UpdateFileUrlLinksInContentParams

Params for updateFileUrlLinksInContent.

Import:

import type { UpdateFileUrlLinksInContentParams } from '@mnaoumov/obsidian-lib/link';

Signature:

export interface UpdateFileUrlLinksInContentParams

Properties

PropertyTypeDescription
abortSignal?AbortSignalThe abort signal to control the execution of the function.
appAppAn Obsidian app instance.
contentstringThe content to normalize the file:// links in.
offsetRange?OffsetRangeA range within UpdateFileUrlLinksInContentParams.content, in character offsets, restricting the pass to the links inside it. When omitted, every link is visited.

A link is normalized 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 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.
shouldUseAngleBrackets?booleanWhether to emit the normalized links with angle brackets and raw spaces instead of %20-encoding.

Links to this page: