igorgoroshit/computed-property

Add computed properties to JavaScript objects.

computed-property

Add computed properties to JavaScript objects.

• Install
• Run tests
• Usage
• API
• Contributing
• Author
• License

(Table of contents generated by [verb])

Install

Install with npm

$ npm i computed-property --save

Run tests

npm test

Usage

var computedProperty = require('computed-property');

API

computedProperty

Add a computed property to an object. This updates the property when dependent properties are updated.

Params

• obj {Object}: Object to add the property to.
• property {String}: Name of the property.
• dependencies {Array}: Optional list of properties to depend on.
• getter {Function}: Getter function that does the calculation.

Example

var computedProperty = require('computed-property');
var file = {
  name: 'home-page',
  ext: '.hbs',
  dirname: 'views',
  data: {
    title: 'Home'
  }
};

computedProperty(
  // object
  file,
  // property name
  'path',
  // optional dependencies (may be deeply nested)
  ['name', 'ext', 'dirname', 'data.title'],
  // getter function
  function () {
    return this.dirname + '/' + this.name + this.ext;
  });

Contributing

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

Author

Brian Woodward

• github/doowb
• twitter/doowb

License

Copyright © 2015 Brian Woodward Released under the MIT license.

---

This file was generated by verb-cli on July 13, 2015.