npm stats
  • Search
  • About
  • Repo
  • Sponsor
  • more
    • Search
    • About
    • Repo
    • Sponsor

Made by Antonio Ramirez

parser-yaml

0.1.1

@jonschlinkert

npmHomeRepoSnykSocket
Downloads:268
$ npm install parser-yaml
DailyWeeklyMonthlyYearly

parser-yaml NPM version

parser-cache compatible YAML parser, using js-yaml.

Install

Install with npm

npm i parser-yaml --save

Run tests

npm test

Usage

var parser = require('parser-yaml');

parse

parser.parse(str, options, function(err, res) {
  if (err) { throw err; }
  console.log(res);
});

parseFile

parser.parseFile('fixtures/a.yml', function (err, res) {
  if (err) { throw err; }
  console.log(res);
});

parseSync

var res = parser.parseSync(str, options);
console.log(res);

API

parse

  • str {String|Object}: The object or string to parse.
  • options {Object|Function}: or cb callback function.
  • cb {Function}: callback function.

Parse the given str of YAML and callback cb(err, obj).

parseSync

  • str {String|Object}: The object or string to parse.
  • returns: {Object}

Parse the given str of YAML.

parseFile

YAML file support. Parse a file at the given filepath and callback callback(err, obj).

  • filepath {String}
  • options {Object|Function}: or callback function.
  • callback {Function}
parser.parseFile('foo/bar/baz.yml');

parseFileSync

YAML file support. Parse a file at the given filepath.

  • filepath {String}
  • options {Object}: Options to pass to [js-yaml]
parser.parseFile('foo/bar/baz.yml');

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue

Author

Jon Schlinkert

  • github/jonschlinkert
  • twitter/jonschlinkert

License

Copyright (c) 2014 Jon Schlinkert
Released under the MIT license


This file was generated by verb on November 24, 2014.