mirror of
https://github.com/denoland/std.git
synced 2024-11-22 04:59:05 +00:00
54 lines
1.3 KiB
TypeScript
54 lines
1.3 KiB
TypeScript
// Copyright 2011-2015 by Vitaly Puzrin. All rights reserved. MIT license.
|
|
// Copyright 2018-2024 the Deno authors. All rights reserved. MIT license.
|
|
// This module is browser compatible.
|
|
|
|
/**
|
|
* {@linkcode parse} and {@linkcode stringify} for handling
|
|
* {@link https://yaml.org/ | YAML} encoded data.
|
|
*
|
|
* Ported from
|
|
* {@link https://github.com/nodeca/js-yaml/commit/665aadda42349dcae869f12040d9b10ef18d12da | js-yaml v3.13.1}.
|
|
*
|
|
* If your YAML contains multiple documents in it, you can use {@linkcode parseAll} for
|
|
* handling it.
|
|
*
|
|
* To handle `regexp`, and `undefined` types, use {@linkcode 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.
|
|
* @example
|
|
* ```ts
|
|
* import {
|
|
* parse,
|
|
* stringify,
|
|
* } from "@std/yaml";
|
|
*
|
|
* 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
|
|
* ```
|
|
*
|
|
* @module
|
|
*/
|
|
|
|
export * from "./parse.ts";
|
|
export * from "./stringify.ts";
|
|
export * from "./type.ts";
|
|
export * from "./schema/mod.ts";
|