GetLinksParams

Params for getLinks.

Import:

import type { GetLinksParams } from 'obsidian-dev-utils/obsidian/metadata-cache';

Signature:

export interface GetLinksParams

Properties

Property	Type	Description
cache	CachedMetadata	The cached metadata to retrieve the links from.
shouldIncludeEmbeds?	boolean	Whether to include the embeds (cache.embeds).
shouldIncludeExternalLinks?	boolean	Whether to include the external links parsed from the note body. Requires the cache to be a CachedMetadataEx.
shouldIncludeFrontmatterExternalLinks?	boolean	Whether to include the external links parsed from single-link (single-value) note frontmatter values. Requires the cache to be a CachedMetadataEx.
shouldIncludeFrontmatterLinks?	boolean	Whether to include the frontmatter links (cache.frontmatterLinks).
shouldIncludeMultiValueFrontmatterExternalLinks?	boolean	Whether 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?	boolean	Whether to include the internal links parsed from multi-link (multi-value) note frontmatter values. Requires the cache to be a CachedMetadataEx.
shouldIncludeReferences?	boolean	Whether to include the reference links (cache.links).

---

Links to this page:

• getLinks