JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 6756
  • Score
    100M100P100Q123824F
  • License MIT

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

Package Exports

  • read-yaml

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 (read-yaml) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

read-yaml NPM version NPM monthly downloads NPM total downloads Linux Build Status

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

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

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

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