Dessert JS-YAML

Clone of js-yaml implemented in Rust for WebAssembly.

dessert-js-yaml is a connector with the WASM core: dessert-yaml-core

For more information, refer to the core

To see how it performs compared to js-yaml, see here

Table of contents

• Usage
• API
• Installation
• License
• Contributing

Usage

yaml = require('dessert-js-yaml');
fs   = require('fs');

// Get document, or throw exception on error
try {
  let doc = yaml.load(fs.readFileSync('/home/ixti/example.yml', 'utf8'));
  console.log(doc);

  // Print the parsed object as a YAML stream
  let yaml_stream = yaml.dump(doc);
  console.log(yaml_stream);
} catch (e) {
  console.log(e);
}

API

The api should be the same as js-yaml, but not all methods are supported yet

load(string, [, options])

Most simple way of parsing a document. Parses string as single YAML document. Returns a JavaScript object or throws YAMLException on error. options aren't used as for now.

loadSafe(string, [, options])

Same as load()

loadAll(string, [, options])

Same as safeLoad(), but understands multi-document sources. Applies iterator to each document if specified, or returns array of documents. Currently same as load() because serde_yaml doesn't support multi document yet, and data structure from yaml-rust aren't serializable.

dump(object, [, options])

Serializes object as a YAML document

safeDump(objects, [, options])

Same as dump()

Installation

npm install dessert-js-yaml

License

This software is licensed under the MIT license (see LICENSE).

Contributing

See CONTRIBUTING.md