API/@functional-examples/devkit/tryParseYaml

tryParseYaml

function

function tryParseYaml<T>(
  content: string,
  filePath?: string
): Promise<
  { data: T; success: true } | { error: YamlParseError; success: false }
>;

Try to parse a YAML string, returning a discriminated union result
instead of throwing.

Requires the yaml peer dependency to be installed.

PARAMETERS

NAME	TYPE	DESCRIPTION
content	`string`	The YAML string to parse
filePath?	`string`	Optional file path for error messages

RETURNS

Promise<{ data: T; success: true } | { error: YamlParseError; success: false }>

TYPE PARAMETERS

T = unknown