Changelog

0.11.8

0.11.6

0.11.5

0.11.0

0.10.0

Install

Node.js

npm install object-path --save

Bower

bower install object-path --save

Typescript typings

typings install --save dt~object-path

Usage

varobj={a:{b:"d",c:["e","f"],'\u1200':'unicode key','dot.dot':'key'}};varobjectPath=require("object-path");//get deep propertyobjectPath.get(obj,"a.b");//returns "d"objectPath.get(obj,["a","dot.dot"]);//returns "key"objectPath.get(obj,'a.\u1200');//returns "unicode key"//get the first non-undefined valueobjectPath.coalesce(obj,['a.z','a.d',['a','b']],'default');//empty a given path (but do not delete it) depending on their type,so it retains reference to objects and arrays.//functions that are not inherited from prototype are set to null.//object instances are considered objects and just own property names are deletedobjectPath.empty(obj,'a.b');// obj.a.b is now ''objectPath.empty(obj,'a.c');// obj.a.c is now []objectPath.empty(obj,'a');// obj.a is now {}//works also with arraysobjectPath.get(obj,"a.c.1");//returns "f"objectPath.get(obj,["a","c","1"]);//returns "f"//can return a default value with getobjectPath.get(obj,["a.c.b"],"DEFAULT");//returns "DEFAULT", since a.c.b path doesn't exists, if omitted, returns undefined//setobjectPath.set(obj,"a.h","m");// or objectPath.set(obj, ["a","h"], "m");objectPath.get(obj,"a.h");//returns "m"//set will create intermediate object/arraysobjectPath.set(obj,"a.j.0.f","m");//will insert values in arrayobjectPath.insert(obj,"a.c","m",1);// obj.a.c = ["e", "m", "f"]//push into arrays (and create intermediate objects/arrays)objectPath.push(obj,"a.k","o");//ensure a path exists (if it doesn't, set the default value you provide)objectPath.ensureExists(obj,"a.k.1","DEFAULT");varoldVal=objectPath.ensureExists(obj,"a.b","DEFAULT");// oldval === "d"//deletes a pathobjectPath.del(obj,"a.b");// obj.a.b is now undefinedobjectPath.del(obj,["a","c",0]);// obj.a.c is now ['f']//tests path existenceobjectPath.has(obj,"a.b");// trueobjectPath.has(obj,["a","d"]);// false//bind objectvarmodel=objectPath({a:{b:"d",c:["e","f"]}});//now any method from above is supported directly w/o passing an objectmodel.get("a.b");//returns "d"model.get(["a.c.b"],"DEFAULT");//returns "DEFAULT"model.del("a.b");// obj.a.b is now undefinedmodel.has("a.b");// false

Howobject-path deals with inherited properties

varproto={notOwn:{prop:'a'}}varobj=Object.create(proto);//This will return undefined (or the default value you specified), because notOwn is//an inherited propertyobjectPath.get(obj,'notOwn.prop');//This will set the property on the obj instance and not the prototype.//In other words proto.notOwn.prop === 'a' and obj.notOwn.prop === 'b'objectPath.set(obj,'notOwn.prop','b');

varobjectPath=require("object-path");varobjectPathWithInheritedProps=objectPath.create({includeInheritedProps:true})

varobjectPath=require("object-path");varobjectPathWithInheritedProps=objectPath.withInheritedProps

varproto={notOwn:{prop:'a'}}varobj=Object.create(proto);//This will return 'a'objectPath.withInheritedProps.get(obj,'notOwn.prop');//This will set proto.notOwn.prop to 'b'objectPath.set(obj,'notOwn.prop','b');

Immutability

Credits