read-data

read-data

Read JSON or YAML files.

Install

Install with npm:

$ npm install --save read-data

Heads up!

Please read the release history, there were breaking changes in 1.0.0!

Usage

var read = require('read-data');

// sync
console.log(read.sync('foo.yml'));
console.log(read.sync('foo.yaml'));
console.log(read.sync('foo.json'));

// async
read('foo.yml', function(err, data) {
  if (err) return console.log(err);
  console.log(data);
});
read('foo.yaml', function(err, data) {
  if (err) return console.log(err);
  console.log(data);
});
read('foo.json', function(err, data) {
  if (err) return console.log(err);
  console.log(data);
});

API

read

Asynchronously read a JSON or YAML file, automatically determining the reader based on extension.

Example

var read = require('read-data');

read('foo.json', function(err, data) {
  if (err) throw err;
  console.log(data);
});

read('foo.yml', function(err, data) {
  if (err) throw err;
  console.log(data);
});

Params

• filepath {String}: path of the file to read.
• options {Object|String}: to pass to js-yaml
• cb {Function}: callback function
• returns {Object}: JSON

.sync

Synchronously read a .json or .(yaml|yml) file, automatically determining the reader based on extension.

Example

var data = require('read-data').data;

var yaml = data.sync('foo.yml');
var json = data.sync('foo.json');

Params

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

.yaml

Asynchronously read a YAML file.

Example

var yaml = require('read-data').yaml;

yaml('foo.yml', function(err, data) {
  if (err) throw err;
  console.log(data);
});

Params

• filepath {String}: path of the file to read.
• options {Object|String}: to pass to js-yaml
• cb {Function}: callback function
• returns {Object}: JSON

.yaml.sync

Synchronously read a YAML file.

Example

var yaml = require('read-data').yaml;
var data = yaml.sync('foo.yml');

Params

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

.json

Asynchronously read a JSON file.

Example

var json = require('read-data');

json('foo.json', function(err, data) {
  if (err) throw err;
  console.log(data);
});

Params

• filepath {String}: path of the file to read.
• callback {Function}: callback function
• returns {Object}: JSON

.json.sync

Synchronously read a JSON file.

Example

var json = require('read-data').json;
var data = json.sync('foo.json');

Params

• filepath {String}: path of the file to read.
• returns {Object}: JSON

History

1.0.0

Breaking changes

• The main export is now a function
• Use read() instead of read.data()
• Use read.sync() instead of read.data.sync()

Everything else is the same.

About

Contributing

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

Contributors

Commits	Contributor
10	jonschlinkert
1	tunnckoCore

Building docs

(This document was generated by verb-generate-readme (a verb generator), please don't edit the readme directly. Any changes to the readme must be made in .verb.md.)

To generate the readme and API documentation with verb:

$ npm install -g verb verb-generate-readme && verb

Running tests

Install dev dependencies:

$ npm install -d && npm test

Author

Jon Schlinkert

• github/jonschlinkert
• twitter/jonschlinkert

License

Copyright © 2016, Jon Schlinkert. Released under the MIT license.

---

This file was generated by verb-generate-readme, v0.2.1, on December 30, 2016.