read-yaml

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

Install

Install with npm:

$ 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

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

.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

var read = require('read-yaml');
var 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:

$ 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:

$ npm install && npm test

Author

Jon Schlinkert

License

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

Current Tags

1.1.0 ... latest (9 years ago)

6 Versions

1.1.0 ... 9 years ago
1.0.0 ... 11 years ago
0.3.1 ... 11 years ago
0.3.0 ... 11 years ago
0.2.0 ... 12 years ago
0.1.0 ... 12 years ago