alancnet / obj-parse

Get and Set object properties in a Fast and Elegant way. (with caching and no dependencies!)

obj-parse

[![NPM version][npm-image]][npm-url] [![Build status][travis-image]][travis-url] [![Test coverage][coveralls-image]][coveralls-url] [![Dependency Status][david-image]][david-url] [![License][license-image]][license-url] [![Downloads][downloads-image]][downloads-url]

Get and Set object properties in a Fast and Elegant way. (with caching and no dependencies!)
Inspire by angular $parse service

Note: This kit works great with deep-keys (creates an array composed of the own enumerable property names of an object).

Install

$ npm install --save obj-parse

Usage

var parse = require('obj-parse');

//object
var person1 = {
  name: 'Ariel Mashraki',
  address: { country: { name: 'Israel', city: 'Tel Aviv' }  }
};

var person2 = {
  name: 'Dan Louis',
  address: { country: { name: 'Canada', city: 'Toronto' }  }
};
    
//property getter
var nameGetter = parse('name');
nameGetter(person1); //Ariel Mashraki
nameGetter(person2); //Dan Louis

//nested propeties with dot notation
var cityGetter = parse('address.country.city');
cityGetter(person1); //Tel Aviv
cityGetter(person2); //Toronto

//bind a function
function ifCanadian(person) {
  return person.address.country.name === 'Canada';
}
var getter = parse(ifCanadian);
getter(person1); //false
getter(person2); //true

//property setter, use the assign function
//return function(scope, value)
var countrySetter = parse('address.country.name').assign;
countrySetter(person1, 'Canada'); //return person1 with changes
countrySetter(person2, 'Israel'); //return person2 with changes

//use again in the ifCanadian
getter(person1); //true
getter(person2); //false

License

MIT © Ariel Mashraki [npm-image]: https://img.shields.io/npm/v/obj-parse.svg?style=flat-square [npm-url]: https://npmjs.org/package/obj-parse [travis-image]: https://img.shields.io/travis/a8m/obj-parse.svg?style=flat-square [travis-url]: https://travis-ci.org/a8m/obj-parse [coveralls-image]: https://img.shields.io/coveralls/a8m/obj-parse.svg?style=flat-square [coveralls-url]: https://coveralls.io/r/a8m/obj-parse [david-image]: http://img.shields.io/david/a8m/obj-parse.svg?style=flat-square [david-url]: https://david-dm.org/a8m/obj-parse [license-image]: http://img.shields.io/npm/l/obj-parse.svg?style=flat-square [license-url]: LICENSE [downloads-image]: http://img.shields.io/npm/dm/obj-parse.svg?style=flat-square [downloads-url]: https://npmjs.org/package/obj-parse