node-read-yaml-files

Read and parse YAML files in a directory and its subdirectories.

Installation

npm install node-read-yaml-files

Usages

const readFiles = require("node-read-yaml-files");
 
readFiles("/path/to/yaml-directory").then((docs) => console.log(docs));

API

readFiles (dirname [ , options ])

options:

• ignores {Array} - Array of filtering string patterns or functions. see more
• flatten {Boolean} (default: false) - Flatten result.
• depth {Number} (default: 1) - The depth level specifying how deep a nested array structure should be flattened.
• withFile {Boolean} (default: false) - Return result with file paths.
• recursive {Boolean} (default: true) - Pass false to disable recursion.

options pass to node-read-yaml:

• 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.

Related

• node-read-yaml - Read and parse a YAML file. A wrapper of js-yaml read file directly.
• js-yaml - JavaScript YAML parser and dumper. Very fast.

License

Copyright (c) 2019 dailyrandomphoto. Licensed under the MIT license.