read-complex-json

Introducing a compact and lightweight library, with an unpacked size of just 1.8kB, that offers an efficient and streamlined approach to handling JSON data. This library empowers developers to effortlessly retrieve the values associated with any key, regardless of its location within the JSON structure. With its minimal footprint, it provides a powerful tool for working with JSON data in a highly optimized manner.

How to Use -

getValues() function

const jsonReader = require('read-complex-json')
//data: your json data(either json string or json object, both will work)
//key: for which you want to find value/values of
const values = jsonReader.getValues(data, key)
//Do something with values

Examples -

const jsonData = {
  "name": "Ram",
  "age": 30,
  "address": {
    "street": "Cannaught Place",
    "city": "New Delhi",
    "state": "New Delhi",
    "pin": "123456"
  },
  "phoneNumbers": [
    {
      "type": "home",
      "number": 999
    },
    {
      "type": "work",
      "number": 888
    }
  ]
};

console.log(jsonReader.getValues(jsonData, 'name'))
//Output: ["Ram"]

console.log(jsonReader.getValues(jsonData, 'number'))
//Output: [999, 888]

console.log(jsonReader.getValues(jsonData, 'phoneNumbers'))
/*Output: [[
    {
      "type": "home",
      "number": 999
    },
    {
      "type": "work",
      "number": 888
    }
  ]]*/

console.log(jsonReader.getValues(jsonData, 'keyNotExists'))
//Output: []

What if json object is not valid

const jsonData = 'Just a string'; //invalid data
console.log(jsonReader.getValues(jsonData, 'someKey'))
//Output: Not a valid json!! Please check again

getValuesFromFile() function

const jsonReader = require('read-complex-json')
//filePath: path of the file where json is stored
//key: for which you want to find value/values of
const values = jsonReader.getValuesFromFile(filePath, key)
//Do something with values

Examples -

const filePath = 'C:/ayush.garg/Documents/read-complex-json/data.json';

//file Data
/*{
  "name": "Ram",
  "age": 30,
  "address": {
    "street": "Cannaught Place",
    "city": "New Delhi",
    "state": "New Delhi",
    "pin": "123456"
  },
  "phoneNumbers": [
    {
      "type": "home",
      "number": 999
    },
    {
      "type": "work",
      "number": 888
    }
  ]
}*/


console.log(jsonReader.getValuesFromFile(filePath, 'name'))
//Output: ["Ram"]

console.log(jsonReader.getValuesFromFile(filePath, 'number'))
//Output: [999, 888]

console.log(jsonReader.getValuesFromFile(filePath, 'phoneNumbers'))
/*Output: [[
    {
      "type": "home",
      "number": 999
    },
    {
      "type": "work",
      "number": 888
    }
  ]]*/
 
console.log(jsonReader.getValuesFromFile(filePath, 'keyNotExists'))
//Output: []

What if json object is not valid

const filePath = 'C:/ayush.garg/Documents/read-complex-json/data.txt';   //Not a json file or invalid json
console.log(jsonReader.getValuesFromFile(filePath, 'someKey'))
//Output: Not a valid json file!! Please check again

For any inquiries, questions, or clarifications regarding this library, we encourage you to reach out to us via email at [email protected]. We are here to provide prompt assistance and address any doubts you may have about the library's functionality, implementation, or any other related concerns. Your feedback is valuable to us, and we are committed to ensuring a seamless experience with our library. Please don't hesitate to contact us; we look forward to assisting you.