Skip to content

ProcessFrontmatterParams.frontmatterFn method

ProcessFrontmatterParams › frontmatterFn

A function that modifies the front matter.

Signature:

frontmatterFn(this: void, frontmatter: CombinedFrontmatter<CustomFrontmatter>, abortSignal: AbortSignal): Promisable<MaybeReturn<null>>

Parameters:

ParameterTypeDescription
thisvoid
frontmatterCombinedFrontmatter<CustomFrontmatter>The front matter to modify.
abortSignalAbortSignalThe abort signal to listen to.

Returns: Promisable<MaybeReturn<null>>A value that may be null to abort the process.