Skip to content

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

License

Notifications You must be signed in to change notification settings

dailyrandomphoto/node-read-yaml-files

Repository files navigation

node-read-yaml-files

NPM Version LICENSE Build Status code style: prettier

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

About

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

Resources

License

Stars

Watchers

Forks

Packages

No packages published