JSPM

get-object

0.2.0
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 351178
  • Score
    100M100P100Q161189F
  • License MIT

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

Package Exports

  • get-object

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (get-object) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

get-object NPM version

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

Install

Install with npm

$ npm i get-object --save

Usage

var get = require('get-object');

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

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

get a value from an object

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

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

get a value from an array

get(['a', 'b', 'c'], '0');
//=> ['a']

get(['a', 'b', 'c'], 2);
//=> ['c']

get nested value from an array

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

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

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

support array notation

get({a: ['a', 'b', 'c']}, 'a[0]');
//=> ['a']

get({a: ['a', 'b', 'c']}, 'a[2]');
//=> ['c']

get({a: {b: ['a', 'b', {c: 'd'}]}}, 'a.b[2].c');
//=> {c: 'd'}
  • 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:

$ 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

License

Copyright © 2015 Jon Schlinkert Released under the MIT license.

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