Skip to content

BacklinksLike

The minimal shape buildBacklinksSnapshot reads a set of backlinks from.

Both a CustomArrayDict<Reference> — what getBacklinksForFileSafe returns — and a plain Map<string, Reference[]> satisfy it, so a caller can pass either without converting first.

Import:

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

Signature:

export interface BacklinksLike

Properties

PropertyTypeDescription
get(key: string) => null | readonly Reference[] | undefinedReturns the links the note at key holds, or a nullish value when it holds none.
keys() => Iterable<string>Returns the paths of the backlink-holding notes.

Links to this page: