Skip to content

ProcessFrontmatterParams<CustomFrontmatter = unknown>

Parameters for processFrontmatter.

Import:

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

Signature:

export interface ProcessFrontmatterParams<CustomFrontmatter = unknown> extends ProcessFrontmatterOptions

Extends: ProcessFrontmatterOptions

Properties

PropertyTypeDescription
appAppThe Obsidian app instance.
pathOrFilePathOrFileThe path or TFile object representing the note.

Methods

MethodReturnsDescription
frontmatterFn(this, frontmatter, abortSignal)Promisable<MaybeReturn<null>>A function that modifies the front matter.

Links to this page: