Skip to content

EditLinksParams.offsetRange?

EditLinksParams › offsetRange?

Type: 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.