Skip to content

LinkUpdater

Unofficial

Handler for updating links within a specific file type when files are renamed or moved.

Import:

import type { LinkUpdater } from '@obsidian-typings/obsidian-public-latest';

Signature:

export interface LinkUpdater

Methods

MethodReturnsDescription
applyUpdates(file, updates)Promise<void>Apply a batch of link change updates to the given file.
iterateReferences(callback)voidIterate over all references managed by this updater.
iterateReferencesForFile(path, callback)voidIterate over all references managed by this updater for a specific file.
renameSubpath(file, oldSubpath, newSubpath)Promise<void>Rename a subpath reference (e.g. heading or block) within a file.

Links to this page: