Skip to content

Use dot notation to get properties from deeply nested object and array structures.

License

Notifications You must be signed in to change notification settings

bigpipe/propget

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

2 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

propget

Propget is a small helper utility for finding values/keys in deeply nested objects without having to worry about undefined properties and what not. It uses a human readable dot based notation to find items in your object or array.

Installation

Just install it through npm, like you do with the all your code:

npm install --save propget

It doesn't use any fancy node.js magic or ES6 so it should be good to go for browser usage as well using something as browserify.

Usage

Using this module is super simple. It exports a single function which accepts 2 arguments;

  1. The object that it needs to extract the data from
  2. A dot notated string for deeply nested object access.
'use strict';

var prop = require('propget')
  , data = { hello: 'world', yo: { deeply: ['nested', 'arrays'] } };

prop(data, 'hello'); // world
prop(data, 'yo.deeply.1'); // arrays
prop(data, 'yo.deeply.nested.unknown.keys'); // undefined

License

MIT

About

Use dot notation to get properties from deeply nested object and array structures.

Resources

License

Stars

Watchers

Forks

Packages

No packages published