node-read-yaml
Read and parse a YAML file. A wrapper of js-yaml
read file directly.
const read = ; const doc = read;console;
same as
const fs = ;const yaml = ; const doc = yaml;console;
Installation
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
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 ofYAMLException
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#id2802346JSON_SCHEMA
- all JSON-supported types: http://www.yaml.org/spec/1.2/spec.html#id2803231CORE_SCHEMA
- same asJSON_SCHEMA
: http://www.yaml.org/spec/1.2/spec.html#id2804923DEFAULT_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
const read = ; ;
wrapper of require('js-yaml').safeLoad
asynchronously read multi-document file
const read = ; ;
wrapper of require('js-yaml').safeLoadAll
synchronously read a file
const readSync = sync; try const doc = ; console; catch err console;
wrapper of require('js-yaml').safeLoad
synchronously read multi-document file
const readSync = sync; try const arr = ; arr; catch err console;
wrapper of require('js-yaml').safeLoadAll
read.YAMLException
require('js-yaml').YAMLException
Related
- node-read-yaml-files - Read and parse YAML files in a directory and its subdirectories.
- js-yaml - JavaScript YAML parser and dumper. Very fast.
License
Copyright (c) 2019 dailyrandomphoto. Licensed under the MIT license.