https://github.com/dabeng/json-loop
JSON Loop is a super easy to use tool class helping you loop the deeply nested JSON object.
https://github.com/dabeng/json-loop
json json-loop
Last synced: about 1 year ago
JSON representation
JSON Loop is a super easy to use tool class helping you loop the deeply nested JSON object.
- Host: GitHub
- URL: https://github.com/dabeng/json-loop
- Owner: dabeng
- License: mit
- Created: 2014-04-04T04:55:58.000Z (about 12 years ago)
- Default Branch: master
- Last Pushed: 2020-12-02T03:06:19.000Z (over 5 years ago)
- Last Synced: 2024-10-31T12:50:26.745Z (over 1 year ago)
- Topics: json, json-loop
- Language: JavaScript
- Homepage:
- Size: 435 KB
- Stars: 19
- Watchers: 5
- Forks: 6
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# JSON Loop
JSON Loop is a super easy to use tool class helping you loop the deeply nested JSON object.
## **[Demo](http://dabeng.github.io/JSON-Loop/)**
## [Here's the ES6 version](https://github.com/dabeng/json-digger)
## Usage
Note: Here I don't provide API specification because the following code snippets are demonstractive enough.
### Sample Data
```javascript
var obj = {
'id': '1', 'name': 'renyang', 'birth': 1985, 'role': 'manager',
'member': [
{
'id': '2', 'name': 'huangfan', 'birth': 1983, 'role': 'manager',
'member': [
{'id': '3', 'name': 'chenxiong', 'birth': 1984, 'role': 'engineer'}
]
},
{
'id': '4', 'name': 'yuguang', 'birth': 1981, 'role': 'engineer manager',
'member': [
{'id': '5', 'name': 'chenjian', 'birth': 1985, 'role': 'engineer'}
]
},
{
'id': '6', 'name': 'deshi', 'birth': 1980, 'role': 'engineer manager',
'member': [
{'id': '7', 'name': 'haibo', 'birth': 1983, 'role': 'engineer'},
{'id': '8', 'name': 'weitao', 'birth': 1987, 'role': 'engineer'},
{'id': '9', 'name': 'liuzheng', 'birth': 1986, 'role': 'engineer'},
{'id': '10', 'name': 'xiaoxue', 'birth': 1988, 'role': 'engineer'},
{'id': '11', 'name': 'xuebin', 'birth': 1982, 'role': 'engineer',
'member': [
{'id': '12', 'name': 'sam', 'birth': 1980, 'role': 'engineer'},
{'id': '13', 'name': 'loklaan', 'birth': 1990, 'role': 'engineer'}
]
}
]
}
]
};
```
### First of all, create a json loop object with required params
```javascript
// the first param is the name of 'Id' property of JSON object and the second one
// is 'children' property name
var jsonloop = new JSONLoop(obj, 'id', 'member');
```
### Find one node based on unique id
```javascript
// node is what we are looking for
jsonloop.findNodeById(obj, '11', function(err, node) {
if (err) {
console.log(err);
} else {
console.dir(node);
}
});
```
### Find the nodes based on conditions
```javascript
// find our uE engineer with her name
jsonloop.findNodes(obj, {'name': 'xiaoxue'}, function(err, nodes) {
nodes.forEach(function(node) {
console.dir(node);
});
});
// find young engineers in our team. Here, nodes is an array of node.
jsonloop.findNodes(obj, {'role': /engineer/i, 'birth': {'>=': 1985, '<': 1990}},
function(err, nodes) {
nodes.forEach(function(node) {
console.dir(node);
});
});
```
### Find a parent node based on a given node
```javascript
jsonloop.findNodeById(obj, '11', function(err, node) {
if (err) {
console.log(err);
} else {
console.clear();
jsonloop.findParent(obj, node, function(err, node) {
console.clear();
if (err) {
console.log(err);
} else {
console.dir(node);
}
});
}
});
```
### Find sibling nodes based on a given node
```javascript
jsonloop.findNodeById(obj, '11', function(err, node) {
if (err) {
console.log(err);
} else {
console.clear();
jsonloop.findSiblings(obj, node, function(err, siblings) {
console.clear();
if (err) {
console.log(err);
} else {
siblings.forEach(function(item) {
console.dir(item);
});
}
});
}
});
```
### Find ancestor nodes based on a given node
```javascript
jsonloop.findNodeById(obj, '12', function(err, node) {
console.clear();
if (err) {
console.log(err);
} else {
jsonloop.findAncestors(obj, node, function(err, ancestors) {
console.clear();
if (err) {
console.log(err);
} else {
ancestors.forEach(function(item) {
console.dir(item);
});
}
});
}
});
```
## Competence
The following are posts related to loop through nested json object where JOSN Loop can work best:
* [\[Stack Overflow\] How do I loop through deeply nested properties of a json object?](http://stackoverflow.com/questions/5189387/how-do-i-loop-through-deeply-nested-properties-of-a-json-object)
* [\[Stack Overflow\] json find parent node of node where key named “id” equal to “value”](http://stackoverflow.com/questions/19047906/json-find-parent-node-of-node-where-key-named-id-equal-to-value)
* [\[Stack Overflow\] Find the path of JSON for a key value](http://stackoverflow.com/questions/18758593/find-the-path-of-json-for-a-key-value)
* [\[Stack Overflow\] Constructively manipulating any value/object within a JSON tree of unknown depth](http://stackoverflow.com/questions/3702844/constructively-manipulating-any-value-object-within-a-json-tree-of-unknown-depth)