https://github.com/dailyrandomphoto/node-read-yaml
Read and parse a YAML file. A wrapper of js-yaml read file directly.
https://github.com/dailyrandomphoto/node-read-yaml
read-file yaml yml
Last synced: 5 months ago
JSON representation
Read and parse a YAML file. A wrapper of js-yaml read file directly.
- Host: GitHub
- URL: https://github.com/dailyrandomphoto/node-read-yaml
- Owner: dailyrandomphoto
- License: mit
- Created: 2019-11-08T03:53:20.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2021-07-26T06:26:38.000Z (almost 5 years ago)
- Last Synced: 2025-05-09T06:55:13.730Z (about 1 year ago)
- Topics: read-file, yaml, yml
- Language: JavaScript
- Size: 15.6 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# node-read-yaml
[![NPM Version][npm-version-image]][npm-url]
[![LICENSE][license-image]][license-url]
[![Build Status][travis-image]][travis-url]
[![code style: prettier][code-style-prettier-image]][code-style-prettier-url]
Read and parse a YAML file. A wrapper of [`js-yaml`](https://github.com/nodeca/js-yaml) read file directly.
```js
const read = require("node-read-yaml");
const doc = read.sync(filename);
console.log(doc);
```
same as
```js
const fs = require("fs");
const yaml = require("js-yaml");
const doc = yaml.safeLoad(fs.readFileSync(filename, "utf8"));
console.log(doc);
```
## Installation
```sh
npm install node-read-yaml
```
## API
### read (filename [ , options ]) | read.sync (filename [ , options ])
Read a YAML file and parse content as JSON.
Returns either a plain object, an array, a string or undefined, or throws YAMLException on error. By default, does not support regexps, functions and undefined. This method is safe for untrusted data.
[more](https://github.com/nodeca/js-yaml#api)
options:
- `multi` _(default: false)_ - If true, then reads file as multi-document and returns an array.
- `onWarning` _(default: null)_ - function to call on warning messages.
Loader will call this function with an instance of `YAMLException` for each warning.
- `schema` _(default: `DEFAULT_SAFE_SCHEMA`)_ - specifies a schema to use.
- `FAILSAFE_SCHEMA` - only strings, arrays and plain objects:
http://www.yaml.org/spec/1.2/spec.html#id2802346
- `JSON_SCHEMA` - all JSON-supported types:
http://www.yaml.org/spec/1.2/spec.html#id2803231
- `CORE_SCHEMA` - same as `JSON_SCHEMA`:
http://www.yaml.org/spec/1.2/spec.html#id2804923
- `DEFAULT_SAFE_SCHEMA` - all supported YAML types, without unsafe ones
(`!!js/undefined`, `!!js/regexp` and `!!js/function`):
http://yaml.org/type/
- `DEFAULT_FULL_SCHEMA` - all supported YAML types.
- `json` _(default: false)_ - compatibility with JSON.parse behaviour. If true, then duplicate keys in a mapping will override values rather than throwing an error.
#### Examples
**asynchronously read a file**
```js
const read = require("node-read-yaml");
read("config.yml")
.then((doc) => console.log(doc))
.catch((err) => console.error(err));
```
wrapper of `require('js-yaml').safeLoad`
**asynchronously read multi-document file**
```js
const read = require("node-read-yaml");
read("config.yml", { multi: true })
.then((arr) => arr.forEach((doc) => console.log(doc)))
.catch((err) => console.error(err));
```
wrapper of `require('js-yaml').safeLoadAll`
**synchronously read a file**
```js
const readSync = require("node-read-yaml").sync;
try {
const doc = readSync("config.yml");
console.log(doc);
} catch (err) {
console.log(err);
}
```
wrapper of `require('js-yaml').safeLoad`
**synchronously read multi-document file**
```js
const readSync = require("node-read-yaml").sync;
try {
const arr = readSync("config.yml", { multi: true });
arr.forEach((doc) => console.log(doc));
} catch (err) {
console.log(err);
}
```
wrapper of `require('js-yaml').safeLoadAll`
### read.YAMLException
`require('js-yaml').YAMLException`
## Related
- [node-read-yaml-files](https://github.com/dailyrandomphoto/node-read-yaml-files) - Read and parse YAML files in a directory and its subdirectories.
- [js-yaml](https://github.com/nodeca/js-yaml) - JavaScript YAML parser and dumper. Very fast.
## License
Copyright (c) 2019 [dailyrandomphoto][my-url]. Licensed under the [MIT license][license-url].
[my-url]: https://github.com/dailyrandomphoto
[npm-url]: https://www.npmjs.com/package/node-read-yaml
[travis-url]: https://travis-ci.org/dailyrandomphoto/node-read-yaml
[license-url]: LICENSE
[code-style-prettier-url]: https://github.com/prettier/prettier
[npm-downloads-image]: https://img.shields.io/npm/dm/node-read-yaml
[npm-version-image]: https://img.shields.io/npm/v/node-read-yaml
[license-image]: https://img.shields.io/npm/l/node-read-yaml
[travis-image]: https://img.shields.io/travis/dailyrandomphoto/node-read-yaml
[code-style-prettier-image]: https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square