@favware/yamlreader
v4.0.2
Published
Minimal wrapper around js-yaml for directly reading in YAML files
Downloads
152
Maintainers
Readme
@favware/yamlreader
Minimal wrapper around js-yaml for directly reading in YAML files
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
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):
This project follows the all-contributors specification. Contributions of any kind welcome!