awesome-yaml-reader

Awesome YAML Reader

Awesome minimal wrapper around js-yaml for directly reading in YAML files

---

Installation

Add the package through your package manager of choice:

npm install awesome-yaml-reader
# yarn add awesome-yaml-reader

Example Usage

const readYaml = require('awesome-yaml-reader');
// supports default import for ES6: import readYaml from 'awesome-yaml-reader'

const actual = readYaml('/path/to/some/yaml/file');
// => JavaScript object with the keys from the yaml

---

readYaml(filepath, [options])

Kind: global function

Param	Type	Description
filepath	string	Path to the yaml file to parse
[options]	AwesomeYamlReaderOptions	Options for the YAML parser and fs file reader

---

This is the documentation for Awesome YAML Reader. Documentation is generated by JSDoc and jsdoc-to-markdown.

© 2019 Jeroen Claassens (Favna) [e-mail]