36 lines
614 B
Plaintext
36 lines
614 B
Plaintext
|
# Load YAML file
|
||
|
|
|
||
|
|
Read and parse a YAML file.
|
||
|
|
|
||
|
|
## Installation
|
||
|
|
|
||
|
|
```sh
|
||
|
|
npm install --save load-yaml-file
|
||
|
|
```
|
||
|
|
|
||
|
|
## Usage
|
||
|
|
|
||
|
|
```js
|
||
|
|
const loadYamlFile = require('load-yaml-file')
|
||
|
|
|
||
|
|
loadYamlFile('foo.yml').then(data => {
|
||
|
|
console.log(data)
|
||
|
|
//=> {foo: true}
|
||
|
|
})
|
||
|
|
```
|
||
|
|
|
||
|
|
## API
|
||
|
|
|
||
|
|
### loadYamlFile(filepath)
|
||
|
|
|
||
|
|
Returns a promise for the parsed YAML.
|
||
|
|
|
||
|
|
### loadYamlFile.sync(filepath)
|
||
|
|
|
||
|
|
Returns the parsed YAML.
|
||
|
|
|
||
|
|
## Related
|
||
|
|
|
||
|
|
- [write-yaml-file](https://github.com/zkochan/write-yaml-file) - Stringify and write YAML to a file atomically
|
||
|
|
- [load-json-file](https://github.com/sindresorhus/load-json-file) - Read and parse a JSON file
|