BuildDocsReferenceGuidesBlog
Discord logo
Discord
GitHub logo
Bun

namespace

YAML

namespace YAML

YAML related APIs

  • function parse(
    input: string
    ): unknown;

    Parse a YAML string into a JavaScript value

    @param input

    The YAML string to parse

    @returns

    A JavaScript value

    import { YAML } from "bun";

console.log(YAML.parse("123")) // 123
console.log(YAML.parse("null")) // null
console.log(YAML.parse("false")) // false
console.log(YAML.parse("abc")) // "abc"
console.log(YAML.parse("- abc")) // [ "abc" ]
console.log(YAML.parse("abc: def")) // { "abc": "def" }
  • function stringify(
    input: unknown,
    replacer?: null,
    space?: string | number
    ): string;

    Convert a JavaScript value into a YAML string. Strings are double quoted if they contain keywords, non-printable or escaped characters, or if a YAML parser would parse them as numbers. Anchors and aliases are inferred from objects, allowing cycles.

    @param input

    The JavaScript value to stringify.

    @param replacer

    Currently not supported.

    @param space

    A number for how many spaces each level of indentation gets, or a string used as indentation. Without this parameter, outputs flow-style (single-line) YAML. With this parameter, outputs block-style (multi-line) YAML. The number is clamped between 0 and 10, and the first 10 characters of the string are used.

    @returns

    A string containing the YAML document.

    import { YAML } from "bun";

const input = {
  abc: "def",
  num: 123
};

// Without space - flow style (single-line)
console.log(YAML.stringify(input));
// {abc: def,num: 123}

// With space - block style (multi-line)
console.log(YAML.stringify(input, null, 2));
// abc: def
// num: 123

const cycle = {};
cycle.obj = cycle;
console.log(YAML.stringify(cycle, null, 2));
// &1
// obj: *1