# required-keys

> make sure the desired key value pairs exist in a given object

Latest version **1.0.5** (published 2013-04-09) · BSD license · 0 weekly downloads

## Install

```sh
npm install required-keys
pnpm add required-keys
yarn add required-keys
bun add required-keys
```

## 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.5 |
| Published | 2013-04-09 |
| First published | 2013-01-20 |
| Weekly downloads | 0 |
| License | BSD |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Noah Isaacson |
| Maintainers | clewfirst |
| Keywords | required, keys |

## Links

- npm: https://www.npmjs.com/package/required-keys
- Repository: https://github.com/nisaacson/required-keys
- npm.io page: https://npm.io/package/required-keys

## Recent versions

- 1.0.5 (latest) — 2013-04-09
- 1.0.4 — 2013-02-05
- 1.0.3 — 2013-02-02
- 1.0.2 — 2013-02-01
- 1.0.1 — 2013-02-01
- 1.0.0 — 2013-01-24
- 0.0.1 — 2013-01-22
- 0.0.0 — 2013-01-20

## README

# Required-Keys
Make sure the desired key value pairs exist in a given object

# Installation
`npm install -S required-keys`

# Usage

### Async
You must pass a callback where the error parameter will be null if there are no errors
**rk.truthy**
```javascript
var rk = require('required-keys');
var keys = ['foo', 'bar'];
var data = {
  foo: false,
  bar: 'test'
}
rk.truthy(data, keys, function(err) {
  console.log('error', err);
});
```


**rk.nonNull**
```javascript
var rk = require('required-keys');
var data = {
  foo: false,
  bar: 'test'
}
var keys = ['foo', 'bar'];
rk.nonNull(data, keys, function(err) {
  console.log('error should be null:', err);
});
```

**rk.keysOnly**
```javascript
var rk = require('required-keys');
var data = {
  foo: null,
  bar: undefined
}
var keys = ['foo', 'bar'];
rk.keysOnly(data, keys, function(err) {
  console.log('error should be null:', err);
});
```


### Sync
All sync methods return null if all checks pass or an array of errors

**rk.truthySync**

```javascript
var keys = ['dog', 'cat', 'lemon']
var data = {
  dog: 'dog',
  cat: 'cat',
  lemon: true,
  apple: ''
}
// err is either null if all keys map to truthy values or an array of errors
var err = rk.truthySync(data, keys)
```

**rk.nonNullSync**

```javascript
var keys = ['dog', 'cat', 'lemon']
var data = {
  dog: 'dog',
  cat: 'cat',
  lemon: false
}
// err is either null if all keys map to truthy values or an array of errors
var err = rk.nonNullSync(data, keys)
should.not.exist(err);
```

**rk.keysOnlySync**

```javascript
var keys = ['dog', 'cat', 'lemon']
var data = {
  dog: null,
  cat: undefined,
  fruit: 'banana'
}
// err is either null if all keys map to truthy values or an array of errors
var err = rk.keysOnlySync(data, keys)
```

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