@favware/yamlreader

Minimal wrapper around js-yaml for directly reading in YAML files

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
@favware/yamlreader
414.0.2a year ago3 years agoMinified + gzip package size for @favware/yamlreader in KB

Readme


logo
@favware/yamlreader
Minimal wrapper around js-yaml for directly reading in YAML files
GitHub codecov npm Depfu

Key Features

  • Useable in NodeJS through package manager of choice
  • Typesafe
  • Bundled with Rollup for maximum size reduction (only 1kB minified + gzipped!) and ES module support
  • Generated TypeScript declarations
  • js-yaml is re-exported

Install

Install with yarn or npm:
yarn add @favware/yamlreader

# npm install @favware/yamlreader

Usage

const { readYaml } = require('@favware/yamlreader');
// import readYaml from '@favware/yamlreader'

const data = readYaml('/path/to/some/yaml/file');
console.log(data); // => JavaScript object with the keys from the yaml

API Documentation

For the full API documentation please refer to the TypeDoc generated documentation.

Buy us some doughnuts

Favware projects are and always will be open source, even if we don't get donations. That being said, we know there are amazing people who may still want to donate just to show their appreciation. Thank you very much in advance!
We accept donations through Open Collective, Ko-fi, Paypal, Patreon and GitHub Sponsorships. You can use the buttons below to donate through your method of choice.
| Donate With | Address | | :-------------: | :-----------------------------------------------: | | GitHub Sponsors | Click Here | | Ko-fi | Click Here | | Patreon | Click Here | | PayPal | Click Here |

Contributors ✨

Thanks goes to these wonderful people (emoji key):
<td align="center"><a href="https://favware.tech/"><img src="https://avatars3.githubusercontent.com/u/4019718?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Jeroen Claassens</b></sub></a><br /><a href="https://github.com/favware/node-packages/commits?author=Favna" title="Code">💻</a> <a href="#infra-Favna" title="Infrastructure (Hosting, Build-Tools, etc)">🚇</a> <a href="#projectManagement-Favna" title="Project Management">📆</a> <a href="https://github.com/favware/node-packages/commits?author=Favna" title="Documentation">📖</a> <a href="https://github.com/favware/node-packages/commits?author=Favna" title="Tests">⚠️</a></td>



This project follows the all-contributors specification. Contributions of any kind welcome!