Skip to content

parseMetadata

Parses the metadata for a given string.

Import:

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

Signature:

function parseMetadata(app: App, str: string, options: ParseCacheOptions): Promise<CachedMetadataEx>

Parameters:

ParameterTypeDescription
appAppThe Obsidian app instance.
strstringThe string to parse the metadata for.
optionsParseCacheOptionsThe parse options controlling which additional links to parse.

Returns: Promise<CachedMetadataEx> — The parsed metadata.


Links to this page: