Skip to content

EditBacklinksParams

Parameters for editBacklinks.

Import:

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

Signature:

export interface EditBacklinksParams extends EditBacklinksOptions

Extends: EditBacklinksOptions

Properties

PropertyTypeDescription
appAppThe Obsidian application instance.
linkConverter(link: Reference) => Promisable<MaybeReturn<string>>The function that converts each link.
linkUpdateProgressReporter?LinkUpdateProgressReporterAn 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.
pathOrFilePathOrFileThe path or file to edit the backlinks for.

Links to this page: