read-yaml

Very thin wrapper around js-yaml for directly reading in YAML files.

Install

Install with npm:

1$ npm install --save read-yaml

API

readYaml

Read yaml file asynchronously and parse content as JSON.

Params

• filepath {String}: Path of the file to read.
• options {Object|String}: to pass to js-yaml
• cb {Function}: Callback function `

Example

1var readYaml = require('read-yaml');
2readYaml('config.yml', function(err, data) {
3  if (err) throw err;
4  console.log(data);
5});

.sync

Read yaml file synchronously and parse content as JSON.

Params

• filepath {String}: Path of the file to read.
• options {Object|String}: to pass to js-yaml.
• returns {Object}: JSON

Example

1var read = require('read-yaml');
2var config = read.sync('config.yml');

About

Related projects

• copy: Copy files or directories using globs. | homepage
• read-data: Read JSON or YAML files. | homepage
• write: Write files to disk, creating intermediate directories if they don't exist. | homepage

Contributing

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

Contributors

Commits	Contributor
15	shinnn
10	jonschlinkert

Building docs

(This project's readme.md is generated by verb, please don't edit the readme directly. Any changes to the readme must be made in the .verb.md readme template.)

To generate the readme, run the following command:

1$ npm install -g verbose/verb#dev verb-generate-readme && verb

Running tests

Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:

1$ npm install && npm test

Author

Jon Schlinkert

• github/jonschlinkert
• twitter/jonschlinkert

License

Copyright © 2017, Jon Schlinkert. Released under the MIT License.

---

This file was generated by verb-generate-readme, v0.4.3, on April 02, 2017.