json-evolve
v21.0.0
Published
Guts Backend Tests
Downloads
248
Readme
jsonEvolve
a package to query json directly without having to parse it into a model
It should be able to parse any JSON without special key characters within their keys or values the following characters: "{},[] are special key characters
HOW TO USE:
run
npm i json-evolve
in terminaladd require:
const je = require('json-evolve/types/jsonEvolve.js').default;
Note: you may need to change package.json "type" to commonJs to use require
- create an assertion or Get a value or Key:
.assert
Assert that a key contains data within your json
je.assert.KeyContainsData(json, key)
Assert that a key with an ancestor contains data within your json
je.assert.KeyWithAncestorContainsData(json, key, ancestor)
Assert that json contains an exact value at a key
je.assert.SubsetEquals(json, key, value)
Assert that json contains value at a key
je.assert.SubsetContains(json, key, value)
Assert that json contains an exact value at a key with a key parent
je.assert.SubsetWithParentEquals(json, key, parentKey, value)
Assert that json contains value at a key with a parent
je.assert.SubsetWithParentContains(json, key, parentKey, value)
Assert that json contains an exact value at a key with a ancestor (parent to (parent of parent of parent...))
je.assert.SubsetWithAncestorEquals(json, key, ancestorKey, value)
Assert that json contains value at a key with a ancestor (parent to (parent of parent of parent...))
je.assert.SubsetWithAncestorContains(json, key, ancestorKey, value)
Assert that json contains an exact value at a index within an Array with a key
je.assert.SubsetOfArrayAtIndexEquals(json, key, index, value)
Assert that json contains value at a index within an Array with a key
je.assert.SubsetOfArrayAtIndexContains(json, key, index, value)
Assert that json contains an exact value at a index within an Array with a key with a parent key
je.assert.SubsetOfArrayAtIndexWithParentEquals(json, key, index, parentKey, value)
Assert that json contains value at a index within an Array with a key with a parent key
je.assert.SubsetOfArrayAtIndexWithParentContains(json, key, index, parentKey, value)
Assert that json contains an exact value at a index within an Array with a key with a Ancestor key
je.assert.SubsetOfArrayAtIndexWithAncestorEquals(json, key, index, ancestorKey, value)
Assert that json contains value at a index within an Array with a key with a Ancestor key
je.assert.SubsetOfArrayAtIndexWithAncestorContains(json, key, index, ancestorKey, value)
.get
VALUE
Get value with Key from Json
je.get.value(json, key)
Get value with key with parent from Json
je.get.valueWithParent(json, key, parentKey)
Get value with key with ancestor from Json
je.get.valueWithAncestor(json, key, ancestorKey)
Get values for an array from Json
je.get.values(json, key)
Get value at index of an array from Json
je.get.valueAtIndex(json, key, index)
Get value of index within multidimensional array from Json (ordered in same way you would call an array arr[parentIndex][index]
je.get.valueAtIndexWithParentIndex: (json, key, parentIndex, index)
KEYS
Get amount of keys in json
je.get.keysAmount(json)
Get Key at index from json
je.get.keyAtIndex(json, index)