Skip to main content

Function: getFrontmatterObjectList()

function getFrontmatterObjectList(
    document: FrontmatterDocument,
    key: string
): readonly Readonly<Record<string, string>>[] | undefined;

Defined in: _internal/frontmatter.ts:632

Read a supported YAML object-list block such as handoffs: entries.

Parameters​

ParameterType
documentFrontmatterDocument
keystring

Returns​

| readonly Readonly<Record<string, string>>[] | undefined