Skip to content

BacklinkConversionParams<TPayload>

Params passed to the link converter of editBacklinksSnapshot.

Import:

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

Signature:

export interface BacklinkConversionParams<TPayload>

Properties

PropertyTypeDescription
linkReferenceThe link being converted.
payloadTPayload | undefinedThe payload captured for the link when the snapshot was built.

undefined when the link is not in the snapshot, which can only happen if EditBacklinksSnapshotParams.shouldVisitUnmatchedLinks is true.
sourcePathstringThe path of the note holding the link.