JSON URI

---

Use URI style methods to operate data. All operations friendly support Vue-like frameworks.

Use

1$ npm install jsonuri --save

1import * as jsonuri from 'jsonuri'
2// or
3import { get, set, ... } from 'jsonuri' // recommended practice, friendly to tree-shaking

Example Data:

1{
2  "menu": {
3    "id": 123,
4    "list": [0, 1, 2, 3, 4],
5    "popup": {
6      "menuitem": [{
7          "value": "New",
8          "onclick": "CreateNewDoc()"
9        },
10        {
11          "value": "Open",
12          "onclick": "OpenDoc()"
13        },
14        {
15          "value": "Close",
16          "onclick": "CloseDoc()"
17        }
18      ]
19    }
20  }
21}
22

Methods:

get (data, path)

Get the value of the specified data for the path.

Example:

1jsonuri.get(data, 'menu/id')
2// return 123
3
4jsonuri.get(data, 'menu/popup/menuitem/0/value')
5// return 'New'
6
7jsonuri.get(data, 'menu/popup/menuitem/0/value/..')
8// {value: "New", onclick: "CreateNewDoc()"}
9

see more

set (data, path, value)

Set the value of the specified data for the path.

Example:

1jsonuri.set(data, 'menu/id/', 789)
2jsonuri.get(data, 'menu/id')
3//789
4

see more

rm (data, path)

Remove the value of the specified data for the path.

Example:

1jsonuri.rm(data, 'menu/id')
2jsonuri.get(data, 'menu/id') // undefined

see more

mv (data, pathA, pathB, sequence)

Data A moved to target B before or after.

Example:

1jsonuri.mv(data, 'menu/list/0', 'menu/list/3')
2jsonuri.get(data, 'menu/list') // [1, 2, 3, 0, 4]
3[see more](test/spec/mv_spec.js)
4
5
6jsonuri.set(data, 'menu/list/',[0,1,2,3,4])
7jsonuri.mv(data, 'menu/list/0', 'menu/list/3', 'before')
8jsonuri.get(data, 'menu/list') // [1, 2, 0, 3, 4]
9

see more

swap (data, pathA, pathB)

Data swap in an array.

Example:

1jsonuri.swap(data, 'menu/list/0', 'menu/list/4')
2jsonuri.get(data, 'menu/list') // [4, 1, 2, 3, 0]
3
4jsonuri.swap(data, 'menu/list/0', 'menu/list/4')
5jsonuri.get(data, 'menu/list') // [4, 1, 2, 3, 0]
6

see more

insert (data, pathA, value, direction)

Insert data into an array that is described in the path.

Example:

1jsonuri.insert(data, 'menu/list/0', 9999, 'before') // [9999, 0, 1, 2, 3, 4]
2

see more

up(data, path, gap)

see more

down(data, path, gap)

see more

walk(data, descentionFn, ascentionFn)

Traverse each data of each node and value.

Example:

1jsonuri.walk({a:{a1:'x'}}, (value, key, parent, { path }) => {
2  console.log(value, key, parent, path)
3})
4
5// { a1: 'x' } 'a' { a: { a1: 'x' } } 'a'
6// x a1 { a1: 'x' } 'a/a1'

see more

normalizePath(path1, path2, ...)

Example:

1jsonuri.normalizePath('a', 'b') // a/b
2
3jsonuri.normalizePath(['a', 'b', '../'], 'c') // a/c
4
5

see more

isCircular(obj)

Example:

1jsonuri.isCircular({}) // return false
2jsonuri.isCircular(window) // return true
3
4var a = {}
5jsonuri.set(a, '/b/c/d/e/f/g', a)
6jsonuri.isCircular(a) // return true
7
8

see more