get-object

Get a property from an object using dot (object path) notation.

Install

Install with npm

1$ npm i get-object --save

Usage

1var get = require('get-object');
2
3get({a: {b: {c: 'd'}}}, 'a.b.c');
4//=> {c: 'd'}

If you want only the value, not key/value, use get-value.

get a value from an object

1get({a: 'aaa', b: {c: 'd'}}, 'a');
2//=> {a: 'aaa'}
3
4get({a: 'a', b: {c: 'd'}}, 'b.c');
5//=> {c: 'd'}

get a value from an array

1get(['a', 'b', 'c'], '0');
2//=> ['a']
3
4get(['a', 'b', 'c'], 2);
5//=> ['c']

get nested value from an array

1get({a: ['a', 'b', 'c']}, 'a.0');
2//=> ['a']
3
4get({a: ['a', 'b', 'c']}, 'a.2');
5//=> ['c']
6
7get({a: {b: ['a', 'b', 'c']}}, 'a.b.2');
8//=> ['c']

support array notation

1get({a: ['a', 'b', 'c']}, 'a[0]');
2//=> ['a']
3
4get({a: ['a', 'b', 'c']}, 'a[2]');
5//=> ['c']
6
7get({a: {b: ['a', 'b', {c: 'd'}]}}, 'a.b[2].c');
8//=> {c: 'd'}

Related projects

• del-value: Delete deeply nested value from an object using dot notation like a.b.c.x and return the… more | homepage
• get-value: Use property paths ( a.b.c) to get a nested value from an object. | homepage
• set-value: Create nested values and any intermediaries using dot notation ('a.b.c') paths. | homepage
• union-value: Set an array of unique values as the property of an object. Supports setting deeply… more | homepage
• unset-value: Delete nested properties from an object using dot notation. | homepage
• upsert-value: Update or set nested values and any intermediaries with dot notation ('a.b.c') paths. | homepage

Running tests

Install dev dependencies:

1$ npm i -d && npm test

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.

Author

Jon Schlinkert

• github/jonschlinkert
• twitter/jonschlinkert

License

Copyright © 2015 Jon Schlinkert Released under the MIT license.

---

This file was generated by verb-cli on August 27, 2015.