Package Exports

yaml-js
yaml-js/yaml.js

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 (yaml-js) 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

yaml-js is a YAML loader and dumper, ported pretty much line-for-line from PyYAML. The goal for the project is to maintain a reliable and specification-complete YAML processor in pure Javascript, with CoffeeScript source code. You can try it out here.

Current Status

The library is being actively maintained for issues, and rather less actively developed for new/improved features.

Loading is stable and well-used, and passes the yaml-spec test suite, which fairly thoroughly covers the YAML 'core' schema (if you notice anything missing, create an issue).

Dumping is present but very lightly tested (auto-tests only, no significant usage). The output should therefore be correct YAML, however formatting is currently entirely untested.

If you use the library and find any bugs, or have any suggestions, don't hesitate to create an issue.

How Do I Get It?

npm install yaml-js

How Do I Use It?

In node (CoffeeScript):

Load

yaml = require 'yaml-js'
console.log yaml.load '''
  ---
  phrase1:
    - hello
    - &world world
  phrase2:
    - goodbye
    - *world
  phrase3: >
    What is up
    in this place.
'''
# { phrase1: [ 'hello', 'world' ],
#   phrase2: [ 'goodbye', 'world' ],
#   phrase3: 'What is up in this place.' }

Dump

yaml = require 'yaml-js'
console.log yaml.dump
  phrase1: [ 'hello',   'world' ]
  phrase2: [ 'goodbye', 'world' ]
  phrase3: 'What is up in this place.'
# phrase1: [hello, world]
# phrase2: [goodbye, world]
# phrase3: What is up in this place.

In the browser:

<script src='yaml.min.js'></script>
<script>
  console.log(yaml.load('hello: world'));
  // { 'hello' : 'world' }
  console.log(yaml.dump({ hello: 'world' }));
  // 'hello: world\n'
</script>

API summary

Method	Description
`scan`	Scan a YAML stream and produce tokens.
`parse`	Parse a YAML stream and produce events.
`compose`	Parse the first YAML document in a stream and produce the corresponding representation tree.
`compose_all`	Parse all YAML documents in a stream and produce corresponding representation trees.
`load`	Parse the first YAML document in a stream and produce the corresponding Javascript object.
`load_all`	Parse all YAML documents in a stream and produce the corresponing Javascript objects.
`emit`	Emit YAML parsing events into a stream.
`serialize`	Serialize a representation tree into a YAML stream.
`serialize_all`	Serialize a sequence of representation trees into a YAML stream.
`dump`	Serialize a Javascript object into a YAML stream.
`dump_all`	Serialize a sequence of Javascript objects into a YAML stream.

License

WTFPL