Get-FrontMatterItem

EulandaXtools — Funktionsreferenz

Get-FrontMatterItem

ÜBERSICHT

Liest einen Eintrag aus einem YAML-FrontMatter-Block und wandelt ihn optional in einen bestimmten Datentyp um.

SYNTAX

Get-FrontMatterItem [-FrontMatter] <string> [-Name] <string> [[-Type] <string>]
    [<CommonParameters>]

BESCHREIBUNG

Diese Funktion extrahiert den Wert eines bestimmten YAML-Schlüssels (`name`) aus einem übergebenen FrontMatter-Block (als Text). Optional kann der Rückgabewert in einen bestimmten Typ (`int`, `datetime`, `double`, `bool`) umgewandelt werden.

Wird der Eintrag nicht gefunden oder ist ungültig, kann ein Defaultwert zurückgegeben werden.

PARAMETER

-FrontMatter

Type: string
Mandatory: True

Der gesamte FrontMatter-Inhalt als String (z. B. von einem Markdown-Dokument).

-Name

Type: string
Mandatory: True

Der Name des zu extrahierenden YAML-Feldes (z. B. `title`, `lastMod`).

-Type

Type: string
Default: 'string'

Gewünschter Rückgabetyp: `string` (Standard), `int`, `datetime`, `double`, `bool`.

-DefaultValue

Optionaler Rückgabewert, falls das Feld nicht existiert oder nicht interpretierbar ist.

BEISPIELE

# Gibt den Wert des Feldes `title` als String zurück.
Get-FrontMatterItem -FrontMatter $front -Name "title"
# Gibt das Datum als [datetime]-Wert zurück oder `MinValue`, wenn ungültig.
Get-FrontMatterItem -FrontMatter $front -Name "lastMod" -Type datetime