Skip to content

processFrontmatter<CustomFrontmatter = unknown>

Processes the front matter of a given file, allowing modifications via a provided function.

Import:

import { processFrontmatter } from 'obsidian-dev-utils/obsidian/file-manager';

Signature:

function processFrontmatter(params: ProcessFrontmatterParams<CustomFrontmatter>): Promise<void>

Parameters:

ParameterTypeDescription
paramsProcessFrontmatterParams<CustomFrontmatter>The parameters for processing the front matter.

Returns: Promise<void> — A Promise that resolves when the front matter has been processed and saved.


Links to this page: