Package Exports

yamljs

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (yamljs) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

yaml.js

Standalone JavaScript YAML 1.2 Parser & Encoder. You don't need any javascript framework to use it.

Mainly inspired from Yaml Component (part of the php framework Symfony).

How to use

Import yaml.js in your html page:

<script type="text/javascript" src="yaml.js"></script>

Parse yaml string:

nativeObject = YAML.parse(yamlString);

Dump native object into yaml string:

yamlString = YAML.stringify(nativeObject[, inline /* @integer depth to start using inline notation at */ ]);

Load yaml file:

nativeObject = YAML.load('file.yml');

Load yaml file:

YAML.load('file.yml', function(result)
{
    nativeObject = result;
});

Use with node.js

Install module:

npm install yamljs

Use it:

YAML = require('yamljs');

// parse YAML string
nativeObject = YAML.parse(yamlString);

// Generate YAML
yamlString = YAML.stringify(nativeObject, 4);

// Load yaml file using require
nativeObject = require('./myfile.yml');

Important

Symfony dropped support for YAML 1.1 spec. This means that yes, no and similar no longer convert to their boolean equivalents.

The internal Yaml().load() and Yaml().loadFile() methods renamed to Yaml().parse() and Yaml().parseFile() respectively. Exceptions replaced with YamlParseException object.