# strip-keys

> An utility for removing specific keys from an object.

Latest version **2.0.0** (published 2022-11-09) · 0 weekly downloads

## Install

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

## Health

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

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.0.0 |
| Published | 2022-11-09 |
| First published | 2017-02-27 |
| Weekly downloads | 0 |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 0 |
| Unpacked size | 6.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Maintainers | fabiospampinato |
| Keywords | strip, remove, object, keys |

## Links

- npm: https://www.npmjs.com/package/strip-keys
- Repository: https://github.com/fabiospampinato/strip-keys
- Homepage: https://github.com/fabiospampinato/strip-keys#readme
- Issues: https://github.com/fabiospampinato/strip-keys/issues
- npm.io page: https://npm.io/package/strip-keys

## Recent versions

- 2.0.0 (latest) — 2022-11-09
- 1.0.5 — 2018-12-06
- 1.0.4 — 2018-11-11
- 1.0.3 — 2018-11-05
- 1.0.2 — 2017-03-05
- 1.0.1 — 2017-03-02
- 1.0.0 — 2017-02-27

## README

# Strip Keys

An utility for removing specific keys from an object.

## Install

```
npm install --save strip-keys
```

## Usage

```js
import stripKeys from 'strip-keys';

const obj = {
  foo: true,
  secret: '1234',
  sub: {
    bar: true,
    secret: 'password'
  }
};

stripKeys ( obj, 'secret' ); // { foo: true, sub: { bar: true } }
stripKeys ( obj, 'secret', false ); // { foo: true, sub: { bar: true, secret: 'password' } }
stripKeys ( obj, ['secret', 'bar'] ); // { foo: true, sub: {} }
```

## API

### `stripKeys ( obj, keys: string | string[], deep: boolean = true )`

Removes a key, or an array of keys, deeply or not, from an object, without mutating the original object.

## License

MIT © Fabio Spampinato

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