Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/aligay/jsonuri
🌳 阿里剑鱼、iceluna、vanex 数据操作底层库，使用O(n) 复杂度回溯祖先节点
https://github.com/aligay/jsonuri
insert jsonpath nullcheck swap
Last synced: 12 days ago
JSON representation
🌳 阿里剑鱼、iceluna、vanex 数据操作底层库，使用O(n) 复杂度回溯祖先节点
- Host: GitHub
- URL: https://github.com/aligay/jsonuri
- Owner: aligay
- License: mit
- Created: 2016-06-16T06:24:27.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2024-05-06T07:15:14.000Z (6 months ago)
- Last Synced: 2024-07-11T17:32:36.336Z (4 months ago)
- Topics: insert, jsonpath, nullcheck, swap
- Language: TypeScript
- Homepage: https://jsonuri.js.org/
- Size: 1.32 MB
- Stars: 138
- Watchers: 5
- Forks: 18
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
- awesome-nodejs - jsonuri - Use URI style methods to operate data.  (Repository / Object / JSON / JSON Schema)
README
# JSON URI
---
`Use URI style methods to operate data.`
All operations friendly support Vue-like frameworks.
[](https://travis-ci.com/github/aligay/jsonuri/branches)
[](https://codecov.io/gh/aligay/jsonuri/branch/master)
[](https://www.npmjs.com/package/jsonuri)
[](https://david-dm.org/aligay/jsonuri)
[](https://david-dm.org/aligay/jsonuri?type=dev)
## Use
```shell
$ npm install jsonuri --save
```
```javascript
import * as jsonuri from 'jsonuri'
// or
import { get, set, ... } from 'jsonuri' // recommended practice, friendly to tree-shaking
```
### Example Data:
```json
{
"menu": {
"id": 123,
"list": [0, 1, 2, 3, 4],
"popup": {
"menuitem": [{
"value": "New",
"onclick": "CreateNewDoc()"
},
{
"value": "Open",
"onclick": "OpenDoc()"
},
{
"value": "Close",
"onclick": "CloseDoc()"
}
]
}
}
}
```
## Methods:
### get (data, path)
Get the value of the specified data for the path.
**Example:**
```javascript
jsonuri.get(data, 'menu/id')
// return 123
jsonuri.get(data, 'menu/popup/menuitem/0/value')
// return 'New'
jsonuri.get(data, 'menu/popup/menuitem/0/value/..')
// {value: "New", onclick: "CreateNewDoc()"}
```
[see more](test/spec/get_spec.js)
### set (data, path, value)
Set the value of the specified data for the path.
**Example:**
```javascript
jsonuri.set(data, 'menu/id/', 789)
jsonuri.get(data, 'menu/id')
//789
```
[see more](test/spec/set_spec.js)
### rm (data, path)
Remove the value of the specified data for the path.
**Example:**
```javascript
jsonuri.rm(data, 'menu/id')
jsonuri.get(data, 'menu/id') // undefined
```
[see more](test/spec/rm_spec.js)
### mv (data, pathA, pathB, sequence)
Data A moved to target B before or after.
**Example:**
```javascript
jsonuri.mv(data, 'menu/list/0', 'menu/list/3')
jsonuri.get(data, 'menu/list') // [1, 2, 3, 0, 4]
[see more](test/spec/mv_spec.js)
jsonuri.set(data, 'menu/list/',[0,1,2,3,4])
jsonuri.mv(data, 'menu/list/0', 'menu/list/3', 'before')
jsonuri.get(data, 'menu/list') // [1, 2, 0, 3, 4]
```
[see more](test/spec/mv_spec.js)
### swap (data, pathA, pathB)
Data swap in an array.
**Example:**
```javascript
jsonuri.swap(data, 'menu/list/0', 'menu/list/4')
jsonuri.get(data, 'menu/list') // [4, 1, 2, 3, 0]
jsonuri.swap(data, 'menu/list/0', 'menu/list/4')
jsonuri.get(data, 'menu/list') // [4, 1, 2, 3, 0]
```
[see more](test/spec/swap_spec.js)
### insert (data, pathA, value, direction)
Insert data into an `array` that is described in the path.
**Example:**
```javascript
jsonuri.insert(data, 'menu/list/0', 9999, 'before') // [9999, 0, 1, 2, 3, 4]
```
[see more](test/spec/insert_spec.js)
### up(data, path, gap)
[see more](test/spec/up_spec.js)
### down(data, path, gap)
[see more](test/spec/down_spec.js)
### walk(data, descentionFn, ascentionFn)
Traverse each data of each node and value.
**Example:**
```javascript
jsonuri.walk({a:{a1:'x'}}, (value, key, parent, { path }) => {
console.log(value, key, parent, path)
})
// { a1: 'x' } 'a' { a: { a1: 'x' } } 'a'
// x a1 { a1: 'x' } 'a/a1'
```
[see more](test/spec/walk_spec.js)
### normalizePath(path1, path2, ...)
**Example:**
```javascript
jsonuri.normalizePath('a', 'b') // a/b
jsonuri.normalizePath(['a', 'b', '../'], 'c') // a/c
```
[see more](test/spec/normalizePath_spec.js)
### isCircular(obj)
**Example:**
```javascript
jsonuri.isCircular({}) // return false
jsonuri.isCircular(window) // return true
var a = {}
jsonuri.set(a, '/b/c/d/e/f/g', a)
jsonuri.isCircular(a) // return true
```
[see more](test/spec/isCircular_spec.js)