Function parse

  • parse(content, options?): unknown

  • Parse and return a YAML string as a parsed YAML document object.

    Note: This does not support functions. Untrusted data is safe to parse.

    Parameters

    • content: string

      YAML string to parse.

    • options: ParseOptions = {}

      Parsing options.

    Returns unknown

    Parsed document.

    Example: Usage

    import { parse } from "@std/yaml/parse";
    import { assertEquals } from "@std/assert";

    const data = parse(`
    id: 1
    name: Alice
    `);

    assertEquals(data, { id: 1, name: "Alice" });

    Throws

    Throws error on invalid YAML.

Settings

Member Visibility