Function stringify

  • stringify(data, options?): string

  • Converts a JavaScript object or value to a YAML document string.

    Parameters

    • data: unknown

      The data to serialize.

    • options: StringifyOptions = {}

      The options for serialization.

    Returns string

    A YAML string.

    Example: Usage

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

    const data = { id: 1, name: "Alice" };
    const yaml = stringify(data);

    assertEquals(yaml, "id: 1\nname: Alice\n");

    Throws

    If data contains invalid types.

Settings

Member Visibility