Skip to main content
Deno 2 is finally here 🎉️
Learn more
Module

x/lume/deps/yaml.ts

🔥 Static site generator for Deno 🦕
lumeland/lume
Very Popular
Go to Latest
import * as lume from "https://deno.land/x/lume@v1.18.3/deps/yaml.ts";

parse and stringify for handling YAML encoded data.

Ported from js-yaml v3.13.1

If your YAML contains multiple documents in it, you can use parseAll for handling it.

To handle regexp, and undefined types, use EXTENDED_SCHEMA. You can also use custom types by extending schemas.

:warning: Limitations

  • binary type is currently not stable.

For further examples see https://github.com/nodeca/js-yaml/tree/master/examples.

Examples

Example 1

import {
  parse,
  stringify,
} from "https://deno.land/std@0.224.0/yaml/mod.ts";

const data = parse(`
foo: bar
baz:
  - qux
  - quux
`);
console.log(data);
// => { foo: "bar", baz: [ "qux", "quux" ] }

const yaml = stringify({ foo: "bar", baz: ["qux", "quux"] });
console.log(yaml);
// =>
// foo: bar
// baz:
//   - qux
//   - quux

Variables

Extends JS-YAML default schema with additional JavaScript types It is not described in the YAML specification. Functions are no longer supported for security reasons.

Functions

Parses content as single YAML document.

Same as parse(), but understands multi-document sources. Applies iterator to each document if specified, or returns array of documents.

Serializes object as a YAML document.