read-yaml-promise

Promise to read and parse a YAML file

1var readYaml = require('read-yaml-promise');
2
3// fixture.yaml
4// - 'foo'
5// - false
6
7readYaml('fixture.yaml')
8.then(function(data) {
9  data; //=> ['foo', false]
10})
11.catch(function(err) {
12  console.log(err.message);
13});

Installation

Use npm.

npm install read-yaml-promise

API

1var readYaml = require('read-yaml-promise');

readYaml(filePath [, options])

filePath: String (file path)
options: Object (options for js-yaml's safeLoad method and fs.readFile), or String (file encoding)
Return: Object (Promise)

When it finish reading and parsing a YAML file, it will be fulfilled with an Object of the parsed data as its first argument.

When it fails to read or parse a file, it will be rejected with an error as its first argument.

1var readYaml = require('read-yaml-promise');
2var FAILSAFE_SCHEMA = require('js-yaml').FAILSAFE_SCHEMA; // npm install js-yaml 
3
4// fixture.yml (foo: true)
5
6readYaml('fixture.yml').then(function(data) {
7  typeof data.foo; //=> 'boolean'
8});
9
10readYaml('fixture.yml', {schema: FAILSAFE_SCHEMA}).then(function(contents) {
11  typeof data.foo; //=> 'string'
12});

options

Note that filename option is automatically specified using the first argument.

License

Copyright (c) 2014 Shinnosuke Watanabe

Licensed under the MIT License.