ProcessFrontmatterParams.frontmatterFunction method
ProcessFrontmatterParams › frontmatterFunction
A function that modifies the front matter.Signature:
frontmatterFunction(this: void, frontmatter: CombinedFrontmatter<CustomFrontmatter>, abortSignal: AbortSignal): Promisable<MaybeReturn<null>>Parameters:
| Parameter | Type | Description |
|---|---|---|
| this | void | |
| frontmatter | CombinedFrontmatter<CustomFrontmatter> | The front matter to modify. |
| abortSignal | AbortSignal | The abort signal to listen to. |
Returns: Promisable<MaybeReturn<null>> — A value that may be null to abort the process.