EditBacklinksParams

Parameters for editBacklinks.

Import:

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

Signature:

export interface EditBacklinksParams extends EditBacklinksOptions

Extends: EditBacklinksOptions

Properties

Property	Type	Description
app	App	The Obsidian application instance.
linkUpdateProgressReporter?	LinkUpdateProgressReporter	An optional reporter invoked once per backlink file after its links are updated, with the running count of processed files and the total. When omitted, no progress is reported.
pathOrFile	PathOrFile	The path or file to edit the backlinks for.

Methods

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

---

Links to this page:

• editBacklinks