kenneth051 / objectdotnotate

Javascript package that turns nested json objects into dotted strings

ObjectDotNotate

ObjectDotNotate turns nested json objects into dotted strings with their corresponding values it takes in an object and returns an object with string notation of all nested objects . This comes in handy when you are filtering a mongo db query using a nested object or a simple object.

Installation

 npm i objectdotnotate

Usage

 var objectdotnotate = require('objectdotnotate');

Example

 var data = {
      obj: "obj",
      nested_once: { first: "first" },
      nested_twice: {
          twice: { inner_nest: { second: "second" } }
      },
      nested_thrice: {
          thrice: { second_nest: { tripple_nest: { tripple: "thrice" }, three: "three" } }
      }
  }

call the relevant method to convert our object

    var returnedObj = objectdotnotate(data)

returnedObj output

        console.log(returnedObj)

  {
    obj: 'obj',
    'nested_once.first': 'first',
    'nested_twice.twice.inner_nest.second': 'second',
    'nested_thrice.thrice.second_nest.tripple_nest.tripple': 'thrice',
    'nested_thrice.thrice.second_nest.three': 'three'
  }

If an object passed in has an array value, Then the output will be as below

Example

data={
    obj: "obj",
        nested_once: { first: "first" },
        nested_twice: {
            twice: { inner_nest: [1,2,3,4,5] }
        }
}

conversion

returnedObj = objectdotnotate(data)

output

console.log(returnedObj)

{
  obj: 'obj',
  'nested_once.first': 'first',
  'nested_twice.twice.inner_nest': [ 1, 2, 3, 4, 5 ]
}

The returned object can easily be looped over while filtering a query.

Don't pass in an array of objects.