JS-YAML

YAML 1.1 parser for JavaScript. Originally ported from PyYAML.

(*) Not feature-compleete, more coming soon:

• YAML 1.2 support
• writer
• JS-specific tags
• internal API for complex operations

Installation

For node.js:

npm install js-yaml

API

JS-YAML automatically registers handlers for .yml and .yaml files. You can load them just with require. That's equivalent to calling loadAll() on file handler. Just with one string!

require('js-yaml');
 
// Get array of documents, or throw exception on error
var docs = require('/home/ixti/examples.yml');
 
console.log(docs);

load ( string|buffer|file_resource )

Parses source as single YAML document. Returns JS object or throws exception on error.

This function does NOT understands multi-doc sources, it throws exception on those.

var yaml = require('js-yaml');
 
// pass the string
fs.readFile('/home/ixti/example.yml', 'utf8', function (err, data) {
  if (err) {
    // handle error
    return;
  }
  try {
    console.log( yaml.load(data) );
  } catch(e) {
    console.log(e);
  }
});

loadAll ( string|buffer|file_resource )

The same as Load, but understands multi-doc sources and returns array of JS objects.

var yaml = require('js-yaml');
 
// pass the string
fs.readFile('/home/ixti/example.yml', 'utf8', function (err, data) {
  if (err) {
    // handle error
    return;
  }
  try {
    console.log( yaml.loadAll(data) );
  } catch(e) {
    console.log(e);
  }
});

JsTagScheme

The list of standard YAML tags and corresponding JavaScipt types. See also YAMLTagDiscussion and Yaml Types.

!!null ''                   # null
!!bool 'yes'                # bool
!!int '3...'                # number
!!float '3.14...'           # number
!!binary '...base64...'     # buffer
!!timestamp 'YYYY-...'      # date
!!omap [ ... ]              # array of key-value pairs
!!pairs [ ... ]             # array or array pairs
!!set { ... }               # array of objects with given keys and null values
!!str '...'                 # string
!!seq [ ... ]               # array
!!map { ... }               # object

The list of JS-specific YAML tags will be availble soon (not implemented yet) and will probably include RegExp, Undefined, function and Infinity.

License

View the LICENSE file