cobj

The cobj(Accessing Object) npm package is a function to easily extract/retrieving data from complex JSON structures by given string path.

Install

$ npm install --save cobj

Uage

Call the cobj function with the JSON object and the path in string to the desired value as arguments:

const cobj = require('cobj')
const result = cobj(jsonObject, path)

• jsonObject: The JSON object or array from which you want to extract a value.
• path: The path to the desired value within the JSON structure. Use dot notation to navigate through nested objects and arrays. Array indices can be used to access specific elements within arrays.

In this example, the cobj function will extract the value located at the path 'a.0' within the object.

The path specifies that we want to access the element at index 0 within the array a. The extracted value, 1, is then returned and printed to the console.

const cobj = require('cobj')
const mock = {
  a: [1, 2]
}
cobj(mock, 'a.0') //1
cobj(mock, 'a.1') //2

Examples

Example 1: Accessing an Object in a Simple Structure

const cobj = require('cobj')
const mock = {
  a: [1, 2],
  b: 3
}
cobj(mock, 'a.0') //1
cobj(mock, 'a.1') //2
cobj(mock, 'b') //3

Example 2: Accessing an Array in a Simple Structure

const cobj = require('cobj')
const mock = [{ a: 1 }, 2];
cobj(mock, '0.a') //1
cobj(mock, '1') //2

Example 3: Accessing a Nested Object and Array in a Complex Structure

const cobj = require('cobj')
const mock = {
        a: {
            b: {
                c: [
                    [ {d: 1} ]
                ]
            }
        }
    }
cobj(mock, 'a.b.c.0.0.d') //1

Test coverage