https://github.com/shinnn/read-yaml-promise

Promise to read and parse a YAML file
https://github.com/shinnn/read-yaml-promise

Last synced: 6 days ago
JSON representation

Promise to read and parse a YAML file

• Host: GitHub
• URL: https://github.com/shinnn/read-yaml-promise
• Owner: shinnn
• License: mit
• Created: 2014-12-05T10:23:00.000Z (almost 10 years ago)
• Default Branch: master
• Last Pushed: 2015-07-01T14:34:53.000Z (over 9 years ago)
• Last Synced: 2024-10-18T19:57:39.419Z (26 days ago)
• Language: JavaScript
• Size: 184 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# read-yaml-promise

[![NPM version](https://img.shields.io/npm/v/read-yaml-promise.svg?style=flat)](https://www.npmjs.com/package/read-yaml-promise)

[![Build Status](https://travis-ci.org/shinnn/read-yaml-promise.svg?branch=master)](https://travis-ci.org/shinnn/read-yaml-promise)

[![Build status](https://ci.appveyor.com/api/projects/status/7gww0bcaas24rshu?svg=true)](https://ci.appveyor.com/project/ShinnosukeWatanabe/read-yaml-promise)

[![Coverage Status](https://img.shields.io/coveralls/shinnn/read-yaml-promise.svg?style=flat)](https://coveralls.io/r/shinnn/read-yaml-promise)

[![Dependency Status](https://img.shields.io/david/shinnn/read-yaml-promise.svg?style=flat&label=deps)](https://david-dm.org/shinnn/read-yaml-promise)

[![devDependency Status](https://img.shields.io/david/dev/shinnn/read-yaml-promise.svg?style=flat&label=devDeps)](https://david-dm.org/shinnn/read-yaml-promise#info=devDependencies)

[Promise] to read and parse a [YAML](http://yaml.org/) file

```javascript

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

// fixture.yaml

// - 'foo'

// - false

readYaml('fixture.yaml')

.then(function(data) {

  data; //=> ['foo', false]

})

.catch(function(err) {

  console.log(err.message);

});

```

## Installation

[Use npm.](https://docs.npmjs.com/cli/install)

```

npm install read-yaml-promise

```

## API

```javascript

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

```

### readYaml(*filePath* [, *options*])

*filePath*: `String` (file path)  

*options*: `Object` (options for [js-yaml](https://github.com/nodeca/js-yaml)'s [safeLoad](https://github.com/nodeca/js-yaml#safeload-string---options-) method and [fs.readFile](https://iojs.org/api/fs.html#fs_fs_readfile_filename_options_callback)), or `String` (file encoding)  

Return: `Object` ([Promise])

When it finish reading and parsing a YAML file, it will be [*fulfilled*](http://promisesaplus.com/#point-26) with an `Object` of the parsed data as its first argument.

When it fails to read or parse a file, it will be [*rejected*](http://promisesaplus.com/#point-30) with an error as its first argument.

```javascript

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

var FAILSAFE_SCHEMA = require('js-yaml').FAILSAFE_SCHEMA; // npm install js-yaml 

// fixture.yml (foo: true)

readYaml('fixture.yml').then(function(data) {

  typeof data.foo; //=> 'boolean'

});

readYaml('fixture.yml', {schema: FAILSAFE_SCHEMA}).then(function(contents) {

  typeof data.foo; //=> 'string'

});

```

#### options

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

## License

Copyright (c) [Shinnosuke Watanabe](https://github.com/shinnn)

Licensed under [the MIT License](./LICENSE).

[Promise]: http://promisesaplus.com/