get-property

get-property

Get a nested property or its value from an object using simple a.b.c paths.

Install

Install with npm:

npm i get-property --save-dev

Run tests

npm test

Usage

var getProperty = require('get-property');

var obj = {a: 'a', b: {c: 'd'}};
get(obj, 'b.c');
//=> {c: 'd'}

Pass true as the last argument to return only the value:

var obj = {a: 'a', b: {c: 'd'}};
get(obj, 'b.c');
//=> 'd'

Examples

get({a: 'a', b: 'b'}, 'a');
//=> {a: 'a'}

get({a: 'a', b: {c: 'd'}}, 'a', true);
//=> 'a'

get({a: 'a', b: {c: 'd'}}, 'b.c');
//=> {c: 'd'}

get({a: 'a', b: {c: 'd'}}, 'b.c', true);
//=> 'd'

get({a: {b: 'c', c: {d: 'e', e: 'f', g: {h: 'i'}}}}, 'a.c.g.h');
//=> {h: 'i'}

get({a: {b: 'c', c: {d: 'e', e: 'f', g: {h: 'i'}}}}, 'a.c.g.h', true);
//=> 'i'

Author

Jon Schlinkert

• github/jonschlinkert
• twitter/jonschlinkert

Other libs

Other javascript/node.js utils that I maintain:

• arrayify-compact
• compact-object
• for-in
• for-own
• has-any
• has-value
• is-number
• is-plain-object
• object-pick
• omit-empty
• reduce-object

License

Copyright (c) 2014 Jon Schlinkert, contributors.
Released under the MIT license

This file was generated by verb-cli on September 22, 2014.