📦 object-dot

Easily use dot notation to get, or set a property of a nested object. A node module.

💥 100% code coverage, zero dependencies and flexible APIs.

Usage

set

Create the nested chain of objects with set and dot notation with one simple statement.

constobjectd=require('object-dot')console.log(objectd.set({object: {},path: 'a.b.c',value: 'foo'}))// => { a: { b: { c: 'foo' }}}// Array of the property chain will work too!console.log(objectd.set({object: {},path: ['a','b','c'],value: 'foo'}))// Alternatively you may use arguments as parameters instead of an object.console.log(objectd.set({},'a.b.c','foo'))

By default any property with values that exists in the path of the chained property is overwritten. The API can be instructed to not overwrite but instead do nothing when this scenario is found. Consider the following:

require('object-dot').extend()letobj={a: {b: {c: 'foo'}}}// By default, the value for `c` is overwrittenconsole.log(Object.set(obj,'a.b.c.d','foo'))//=> { a: { b: { c: { d: 'foo' }}}}// Tell the API not to overwriteconsole.log(Object.set(obj,'a.b.c.d','foo',false))//=> { a: { b: { c: 'foo' }}}// Alternatively, you may call it with an object as a parameterObject.set({object: obj,path: 'a.b.c.d',value: 'foo',overwrite: false})

get

Get the value of a nested chain of objects without checking each object in the chain for its existence.

constobjectd=require('object-dot')// when one of the properties in the chain is undefined. Safely return undefined.letobject={foo: {bar: 'you!'}}console.log(objectd.get({ object,path: 'foo.bar.c.d'}))//=> undefined// return a default value if property is undefinedobject={foo: {bar: 'you!'}}console.log(objectd.get({ object,path: 'foo.bar.c.d',value: 'my default value'}))//=> 'my default value'// When the property exist.object={a: {foo: {bar: 'you!'}}}console.log(objectd.get({ object,path: 'a.foo'}))//=> { bar: 'you!' }// Plain arguments as parameters will work too!console.log(objectd.get(object,'a.foo.bar'))// => 'you!'// Using arrays instead of dot notation is also supported.console.log(objectd.get(object,['a','foo','bar']))// => 'you!'

exists

The exists method determines if a chained object exist.

constobjectd=require('object-dot')// when one of the properties in the chain is undefined. Safely return undefined.letobject={foo: {bar: 'you!'}}console.log(objectd.exists({ object,path: 'foo.bar'}))//=> true// alternatively using plain old arguments work too.console.log(objectd.exists(object,'foo.bar'))

extend

Use the extend method to add the methods, get, set and exists to the Object prototype chain:

require('object-dot').extend()letobject={foo: {bar: 'you!'}}console.log(Object.exists(object,'foo.bar'))//=> true

Install

$ npm install object-dot --save

License

ISC