Skip to content

Reads YAML 1.2 from a file. Returns null if file does not exist (or is a directory) instead of throwing an Error.

License

Notifications You must be signed in to change notification settings

Jaid/read-file-yaml

Repository files navigation

read-file-yaml

License Sponsor read-file-yaml
Build status Commits since v2.0.0 Last commit Issues
Latest version on npm Dependents Downloads

Reads YAML 1.2 from a file. Returns null if file does not exist (or is a directory) instead of throwing an Error.

Installation

read-file-yaml on npm

npm install --save read-file-yaml@^2.0.0

read-file-yaml on Yarn

yarn add read-file-yaml@^2.0.0

@jaid/read-file-yaml on GitHub Packages
(if configured properly)

npm install --save @jaid/read-file-yaml@^2.0.0

Example

import readFileYaml from "read-file-yaml"

readFileYaml("./exists.yml").then(result => {

})

readFileYaml("./doesNotExist.yml").then(result2 => {

})

Variable result will be:

["a", "b", "c"]

Variable result2 will be:

null

Development

Setting up:

git clone [email protected]:jaid/read-file-yaml.git
cd read-file-yaml
npm install

Testing:

npm run test:dev

Testing in production environment:

npm run test

License

MIT License
Copyright © 2020, Jaid <[email protected]> (https://github.com/jaid)