# yam

> Dead simple storage interface

Latest version **1.0.0** (published 2018-07-14) · MIT license · 0 weekly downloads

## Install

```sh
npm install yam
pnpm add yam
yarn add yam
bun add yam
```

## Health

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

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2018-07-14 |
| First published | 2014-05-01 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | ^4.5 \|\| 6.* \|\| >= 7.* |
| Dependencies | 2 |
| Unpacked size | 23.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 5 |
| Author | Alex Navasardyan |
| Maintainers | kellyselden, stefanpenner, twokul |
| Keywords | storage, config |

## Links

- npm: https://www.npmjs.com/package/yam
- Repository: https://github.com/twokul/yam
- Homepage: https://github.com/twokul/yam#readme
- Issues: https://github.com/twokul/yam/issues
- npm.io page: https://npm.io/package/yam

## Dependencies (2)

- [fs-extra](https://npm.io/package/fs-extra.md) ^4.0.2
- [lodash.merge](https://npm.io/package/lodash.merge.md) ^4.6.0

## Alternatives

- [jsforce](https://npm.io/package/jsforce.md) — 851.2K weekly downloads
- [react-native-qrcode-svg](https://npm.io/package/react-native-qrcode-svg.md) — 693.5K weekly downloads
- [@salesforce/plugin-data](https://npm.io/package/@salesforce/plugin-data.md) — 394.9K weekly downloads
- [@backstage/plugin-search-common](https://npm.io/package/@backstage/plugin-search-common.md) — 308.5K weekly downloads
- [@chain-registry/types](https://npm.io/package/@chain-registry/types.md) — 38.4K weekly downloads

## Recent versions

- 1.0.0 (latest) — 2018-07-14
- 0.0.24 — 2018-02-05
- 0.0.23 — 2017-12-15
- 0.0.22 — 2016-08-05
- 0.0.21 — 2016-07-14
- 0.0.20 — 2016-06-14
- 0.0.19 — 2016-04-15
- 0.0.18 — 2015-03-02
- 0.0.17 — 2014-11-13
- 0.0.16 — 2014-09-06
- 0.0.15 — 2014-08-28
- 0.0.14 — 2014-08-27
- 0.0.13 — 2014-08-15
- 0.0.12 — 2014-06-11
- 0.0.11 — 2014-06-11
- … 11 more at https://npm.io/package/yam/versions

## README

yam
====

[![Build Status](https://travis-ci.org/twokul/yam.svg)](https://travis-ci.org/twokul/yam)

Dead simple lazy storage interface, useful to store cli or project settings. The file being parsed is expected in valid JSON format that can include comments.

#### Yam Constructor
```javascript
var Yam = require('yam');

//looks for a .test file in the current directory as well as your home directory
var yam = new Yam('test');

//customize where the file is located
var yam = new Yam('test', {
  primary: 'path/to/primary/location',
  secondary: 'path/to/secondary/location'
});
```

`.test` file example:
```javascript
{
  //comments are valid
  'foo': 'bar'
}
```

#### Get

```javascript
yam.get('foo'); // => 'bar'
```
#### GetAll

```javascript
yam.getAll();
```

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