Skip to content
This repository has been archived by the owner on Jun 25, 2020. It is now read-only.
/ js-yaml Public archive

CommonJS YAML Parser -- fast, elegant and tiny yaml parser for javascript

Notifications You must be signed in to change notification settings

tj/js-yaml

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

YAML

CommonJS JavaScript YAML parser, fast and tiny. Although this implementation does not currently support the entire YAML specification, feel free to fork the project and submit a patch :)

Usage

require('yaml').eval(string_of_yaml)

Currently Supports

  • Comments
  • Sequences (arrays)
  • Maps (hashes)
  • Inline sequences
  • Inline maps
  • Nesting
  • Primitive scalars (integers, floats, booleans, etc)
  • Extended bools (enabled, disabled, yes, no, on, off, true, false)

Installation

$ npm install yaml

Testing

Update git submodules and run:

$ make test

License

(The MIT License)

Copyright (c) 2009 TJ Holowaychuk tj@vision-media.ca

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

About

CommonJS YAML Parser -- fast, elegant and tiny yaml parser for javascript

Resources

Stars

Watchers

Forks

Packages

No packages published