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 v1.0.2 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@^1.0.2

read-file-yaml on Yarn

yarn add read-file-yaml@^1.0.2

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

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

Example

import readFileYaml from "read-file-yaml"

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

})

Variable result will now 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]> (github.com/jaid)

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.