parseFrontMatterEntry

Official

Parses a frontmatter entry from the frontmatter object.

Import:

import { parseFrontMatterEntry } from 'obsidian';

Example:

console.log(parseFrontMatterEntry({ foo: 'bar' }, 'foo')); // bar
console.log(parseFrontMatterEntry({ baz: 'qux' }, /ba./)); // qux

Signature:

function parseFrontMatterEntry(frontmatter: unknown, key: string | RegExp): unknown

Parameters:

Parameter	Type	Description
frontmatter	unknown	The frontmatter object.
key	string | RegExp	The key to parse.

Returns: unknown — The parsed entry or null if the key is not found.

Example:

console.log(parseFrontMatterEntry({ foo: 'bar' }, 'foo')); // bar
console.log(parseFrontMatterEntry({ baz: 'qux' }, /ba./)); // qux