Skip to content

parseFrontmatterLinks

Parses the links from a note’s frontmatter. Each string value is parsed via parseLinks: a value that is a single link yields an entry without offsets, and a value that holds multiple links yields offset-carrying entries. Internal single-link values are omitted, as Obsidian natively caches them.

Import:

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

Signature:

function parseFrontmatterLinks(frontmatter: unknown): ParseFrontmatterLinksResult

Parameters:

ParameterTypeDescription
frontmatterunknownThe frontmatter to parse (a value, object, or array).

Returns: ParseFrontmatterLinksResult — The parsed frontmatter links.


Links to this page: