computed-property

Add computed properties to JavaScript objects.

Install

Install with npm:

$ npm install --save computed-property

Install with yarn:

$ yarn add computed-property

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;
  });

About

Contributing

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

Contributors

| Commits | Contributor |
| --- | --- |
| 10 | doowb |
| 7 | pgilad |

Building docs

(This project's readme.md is generated by verb, please don't edit the readme directly. Any changes to the readme must be made in the .verb.md readme template.)

To generate the readme, run the following command:

$ npm install -g verbose/verb#dev verb-generate-readme && verb

Running tests

Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:

$ npm install && npm test

Author

Brian Woodward

• github/doowb
• twitter/doowb

License

Copyright © 2017, Brian Woodward. Released under the MIT License.

This file was generated by verb-generate-readme, v0.6.0, on June 03, 2017.