Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hlefebvr/json-manipulation
Small module which enables to manipulate json structures.
https://github.com/hlefebvr/json-manipulation
json json-manipulation omit
Last synced: 3 months ago
JSON representation
Small module which enables to manipulate json structures.
- Host: GitHub
- URL: https://github.com/hlefebvr/json-manipulation
- Owner: hlefebvr
- License: mit
- Created: 2017-10-11T14:51:55.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2018-08-08T12:48:57.000Z (almost 6 years ago)
- Last Synced: 2024-03-22T17:47:11.863Z (4 months ago)
- Topics: json, json-manipulation, omit
- Language: JavaScript
- Homepage:
- Size: 16.6 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Lists
- awesome - hlefebvr/json-manipulation - Small module which enables to manipulate json structures. (JavaScript)
README
# json-omit : JSON manipulation node module
Install : `npm install --save json-omit`
Available functions :
- `omit(originialObject, ...paths)` : copies the `originalObject` and deletes attributes specified in `...paths` before returning the result
- `clone(originalObject)` : retruns a **deep** copy of the `originalObject`
## Examples
```javascript
const { omit, clone } = require("json-omit");
```
### omit(originalObject, ...paths)
omit attributes or nested attributes :
```javascript
const orignialObject = {
depth0: {
depth1: {
attr1: "keep this attribute",
attr2: { value: "remove me" },
attr3: "remove me as well"
}
},
someOtherAttribute: "I should be removed"
};
const omitted = omit(
originalObject,
"depth0.depth1.attr2",
"depth0.depth1.attr3",
"someOtherAttribute"
);
console.log(omitted);
/*
{
depth0: {
depth1: {
attr1: "keep this attribute"
}
}
}
*/
```
omit attribute or nested attribute in every row of array
```javascript
const originalObject = {
history: [
{ timestamp: "1234567", value: "example1" },
{ timestamp: "1234568", value: "example1", extraValue: true },
{ timestamp: "1234569", value: "example1" },
{ timestamp: "1234570", value: "example1" }
]
};
const omitted = omit(originalObject, "history.value");
console.log(omitted);
/*
{
history: [
{ timestamp: "1234567" },
{ timestamp: "1234568" },
{ timestamp: "1234569" },
{ timestamp: "1234570" }
]
}
*/
```
omit attribute or nested attribute in specific row of array
```javascript
const originalObject = {
history: [
{ timestamp: "1234567", value: "example1" },
{ timestamp: "1234568", value: "example1" },
{ timestamp: "1234569", value: "example1" },
{ timestamp: "1234570", value: "example1" }
]
};
const omitted = omit(originalObject, "history.2.value");
console.log(omitted);
/*
{
history: [
{ timestamp: "1234567", value: "example1" },
{ timestamp: "1234568", value: "example1" },
{ timestamp: "1234569" },
{ timestamp: "1234570", value: "example1" }
]
};
*/
```
### clone(originalObject)
```javascript
const originalObject = {
depth0: { depth1: { depth2: { value: "nested value" } } }
};
const copiedObject = clone(originalObject);
copiedObject.depth0.depth1.depth2.value = "changed nested value";
console.log(originalObject.depth0.depth1.depth2.value); // outputs "nested value"
console.log(copiedObject.depth0.depth1.depth2.value); // outputs "changed nested value"
```
## Contributing
- Contributing is **very welcomed** via pull requests or creating issues
- If you make a pull request, be sure to write/adapt a test file with respect to your specific changes
- Running tests is done via mocha and npm, run them like so : `npm t`