Skip to content

ProcessFrontmatterParams<CustomFrontmatter = unknown>

Parameters for processFrontmatter.

Import:

import type { ProcessFrontmatterParams } from '@mnaoumov/obsidian-lib/file-manager';

Signature:

export interface ProcessFrontmatterParams<CustomFrontmatter = unknown> extends ProcessFrontmatterOptions

Extends: ProcessFrontmatterOptions

Properties

PropertyTypeDescription
appAppThe Obsidian app instance.
frontmatterFunction(frontmatter: CombinedFrontmatter<CustomFrontmatter>, abortSignal: AbortSignal) => Promisable<MaybeReturn<null>>A function that modifies the front matter.
pathOrFilePathOrFileThe path or TFile object representing the note.

Links to this page: