EditBacklinksSnapshotParams<TPayload>
Parameters for editBacklinksSnapshot.
Import:
import type { EditBacklinksSnapshotParams } from 'obsidian-dev-utils/obsidian/link';Signature:
export interface EditBacklinksSnapshotParams<TPayload> extends EditBacklinksSnapshotOptionsExtends: EditBacklinksSnapshotOptions
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. |
| shouldVisitUnmatchedLinks? | boolean | Whether the converter is also shown links that are **not** in the snapshot, with an undefined BacklinkConversionParams.payload.The default filters them out, which is what a plain rename wants: a link absent from the snapshot was either never the caller's to rewrite, or has already been rewritten by someone else. Set this to true only when the caller has its own reason to look at them — a widened match of its own, or logging a skip that would otherwise be silent. |
| snapshot | BacklinksSnapshot<TPayload> | The captured backlinks to edit. |
Methods
| Method | Returns | Description |
|---|---|---|
| linkConverter(this, params) | Promisable<MaybeReturn<string>> | The function that converts each link. |
| linkIdentityKeyProvider(this, link) | string | Computes the identity key of a link. Must be the same function passed to buildBacklinksSnapshot, or no link will ever match. |
Links to this page: