Skip to content

GetReferencesParams

Params for getReferences.

Import:

import type { GetReferencesParams } from '@mnaoumov/obsidian-lib/metadata-cache';

Signature:

export interface GetReferencesParams

Properties

PropertyTypeDescription
cacheCachedMetadataThe cached metadata to retrieve the references from.
shouldIncludeEmbeds?booleanWhether to include the embeds (cache.embeds).
shouldIncludeExternalLinks?booleanWhether to include the external links parsed from the note body. Requires the cache to be a CachedMetadataEx.
shouldIncludeFrontmatterExternalLinks?booleanWhether to include the external links parsed from single-link (single-value) note frontmatter values. Requires the cache to be a CachedMetadataEx.
shouldIncludeFrontmatterLinks?booleanWhether to include the frontmatter links (cache.frontmatterLinks).
shouldIncludeLinks?booleanWhether to include the body links (cache.links).
shouldIncludeMultiValueFrontmatterExternalLinks?booleanWhether to include the external links parsed from multi-link (multi-value) note frontmatter values, i.e. the offset-carrying frontmatter external links (narrowed via isFrontmatterLinkCacheWithOffsets). Requires the cache to be a CachedMetadataEx.
shouldIncludeMultiValueFrontmatterLinks?booleanWhether to include the internal links parsed from multi-link (multi-value) note frontmatter values. Requires the cache to be a CachedMetadataEx.

Links to this page: