# load-yml

> Read and parse a .yaml or .yml file

Latest version **1.4.0** (published 2023-08-28) · MIT license · 0 weekly downloads

## Install

```sh
npm install load-yml
pnpm add load-yml
yarn add load-yml
bun add load-yml
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities.

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.4.0 |
| Published | 2023-08-28 |
| First published | 2023-01-18 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Node | >=12.20 |
| Dependencies | 3 |
| Unpacked size | 11.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 3 |
| Author | saqqdy |
| Maintainers | saqqdy |
| Keywords | yaml, load-yaml, load-yml, yaml-parser, saqqdy |

## Links

- npm: https://www.npmjs.com/package/load-yml
- Repository: https://github.com/saqqdy/load-yml
- Homepage: https://github.com/saqqdy/load-yml#readme
- Issues: https://github.com/saqqdy/load-yml/issues
- npm.io page: https://npm.io/package/load-yml

## Dependencies (3)

- [tslib](https://npm.io/package/tslib.md) ^2.6.2
- [js-yaml](https://npm.io/package/js-yaml.md) ^4.1.0
- [@types/js-yaml](https://npm.io/package/@types/js-yaml.md) ^4.0.5

## Alternatives

- [monaco-yaml](https://npm.io/package/monaco-yaml.md) — 420.1K weekly downloads
- [@crewx/workflow](https://npm.io/package/@crewx/workflow.md) — 3.1K weekly downloads
- [yaml-cat](https://npm.io/package/yaml-cat.md) — 38 weekly downloads
- [nunjucks-in-yaml](https://npm.io/package/nunjucks-in-yaml.md) — 9 weekly downloads
- [shopify-symlinks](https://npm.io/package/shopify-symlinks.md) — 3 weekly downloads

## Recent versions

- 1.4.0 (latest) — 2023-08-28
- 1.0.0-beta.1 (beta) — 2023-02-04
- 1.0.0-alpha.0 (alpha) — 2023-01-18
- 1.3.0 — 2023-03-01
- 1.2.0 — 2023-02-05
- 1.1.1 — 2023-02-04
- 1.1.0 — 2023-02-04
- 1.0.0 — 2023-02-04

## README

<div style="text-align: center;" align="center">

# load-yml

Read and parse a .yaml or .yml file

[![NPM version][npm-image]][npm-url]
[![Codacy Badge][codacy-image]][codacy-url]
[![tree shaking][tree-shaking-image]][tree-shaking-url]
![typescript][typescript-url]
[![Test coverage][codecov-image]][codecov-url]
[![npm download][download-image]][download-url]
[![License][license-image]][license-url]

[![Sonar][sonar-image]][sonar-url]

</div>

<div style="text-align: center; margin-bottom: 20px;" align="center">

### **[Documentation](https://www.saqqdy.com/load-yml)** • **[Change Log](./CHANGELOG.md)**

</div>

## Installing

```bash
# use pnpm
$ pnpm install load-yml

# use npm
$ npm install load-yml --save

# use yarn
$ yarn add load-yml
```

## Usage

1. use `load-yml` in async mode

```js
import { loadYml } from 'load-yml'

loadYml().then(path => {
  console.log('result is: ', path) // { "name": "saqqdy" }
})
```

2. use `load-yml` in sync mode

```js
import { loadYmlSync } from 'load-yml'

console.log('result is: ', loadYmlSync()) // { "name": "saqqdy" }
```

## Support & Issues

Please open an issue [here](https://github.com/saqqdy/load-yml/issues).

## License

[MIT](LICENSE)

[npm-image]: https://img.shields.io/npm/v/load-yml.svg?style=flat-square
[npm-url]: https://npmjs.org/package/load-yml
[codacy-image]: https://app.codacy.com/project/badge/Grade/f70d4880e4ad4f40aa970eb9ee9d0696
[codacy-url]: https://www.codacy.com/gh/saqqdy/load-yml/dashboard?utm_source=github.com&utm_medium=referral&utm_content=saqqdy/load-yml&utm_campaign=Badge_Grade
[tree-shaking-image]: https://badgen.net/bundlephobia/tree-shaking/load-yml
[tree-shaking-url]: https://bundlephobia.com/package/load-yml
[typescript-url]: https://badgen.net/badge/icon/typescript?icon=typescript&label
[codecov-image]: https://img.shields.io/codecov/c/github/saqqdy/load-yml.svg?style=flat-square
[codecov-url]: https://codecov.io/github/saqqdy/load-yml?branch=master
[download-image]: https://img.shields.io/npm/dm/load-yml.svg?style=flat-square
[download-url]: https://npmjs.org/package/load-yml
[license-image]: https://img.shields.io/badge/License-MIT-blue.svg
[license-url]: LICENSE
[sonar-image]: https://sonarcloud.io/api/project_badges/quality_gate?project=saqqdy_load-yml
[sonar-url]: https://sonarcloud.io/dashboard?id=saqqdy_load-yml

---
_Source: https://npm.io/package/load-yml · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._