Skip to content

buildBacklinksSnapshot<TPayload>

Records a set of backlinks into a snapshot that editBacklinksSnapshot can rewrite later.

Call it once per target and pass BuildBacklinksSnapshotParams.target to accumulate several targets into one snapshot, so that a note linking to several of them is still rewritten exactly once.

Import:

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

Signature:

function buildBacklinksSnapshot(params: BuildBacklinksSnapshotParams<TPayload>): MutableBacklinksSnapshot<TPayload>

Parameters:

ParameterTypeDescription
paramsBuildBacklinksSnapshotParams<TPayload>The parameters for building the snapshot.

Returns: MutableBacklinksSnapshot<TPayload> — The snapshot — BuildBacklinksSnapshotParams.target itself when one was passed.


Links to this page: