https://github.com/detrohutt/deep-stripper
Strip an object deeply of any key or keys you provide
https://github.com/detrohutt/deep-stripper
keys object strip
Last synced: 4 months ago
JSON representation
Strip an object deeply of any key or keys you provide
- Host: GitHub
- URL: https://github.com/detrohutt/deep-stripper
- Owner: detrohutt
- License: mit
- Created: 2017-05-09T22:02:17.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2018-04-05T03:29:13.000Z (about 8 years ago)
- Last Synced: 2025-10-21T04:01:46.686Z (9 months ago)
- Topics: keys, object, strip
- Language: JavaScript
- Size: 61.5 KB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Deep Stripper
Strip any number of unwanted keys from an object, deeply.
## Install
```
yarn add deep-stripper
```
## Use
`deepStrip(obj: Object, ...keys: String) : Object`
You can call the function whatever you'd like when you import it. It's first parameter is the object you'd like to strip keys from. Every parameter after that is the name of a key you'd like stripped. A new object is returned and the original object is not mutated.
## Example
```javascript
import deepStrip from 'deep-stripper'
const productGroup = {
productGroupId: '59115d3fd29c4b172789b2bf',
name: 'Stripper Starter Kit',
listingIds: [ '1234567890' ],
productArray: [
{
productId: 'XXX-POLE-CHROME',
quantity: 1,
__typename: 'ProductGroupMember'
},
{
productId: 'XXX-PASTIES-BLUE',
quantity: 2,
__typename: 'ProductGroupMember'
}
],
__typename: 'ProductGroup'
}
console.log(deepStrip(productGroup, '__typename', 'productGroupId'))
```
```javascript
// Output:
{
name: 'Stripper Starter Kit',
listingIds: [ '1234567890' ],
productArray: [
{
productId: 'XXX-POLE-CHROME',
quantity: 1
},
{
productId: 'XXX-PASTIES-BLUE',
quantity: 2
}
]
}
```