computed-property/README.md

Add computed properties to JavaScript objects.

# computed-property [![NPM version](https://img.shields.io/npm/v/computed-property.svg?style=flat)](https://www.npmjs.com/package/computed-property) [![NPM monthly downloads](https://img.shields.io/npm/dm/computed-property.svg?style=flat)](https://npmjs.org/package/computed-property)  [![NPM total downloads](https://img.shields.io/npm/dt/computed-property.svg?style=flat)](https://npmjs.org/package/computed-property) [![Linux Build Status](https://img.shields.io/travis/doowb/computed-property.svg?style=flat&label=Travis)](https://travis-ci.org/doowb/computed-property) [![Windows Build Status](https://img.shields.io/appveyor/ci/doowb/computed-property.svg?style=flat&label=AppVeyor)](https://ci.appveyor.com/project/doowb/computed-property)

> Add computed properties to JavaScript objects.

## Install

Install with [npm](https://www.npmjs.com/):

```sh
$ npm install --save computed-property
```

Install with [yarn](https://yarnpkg.com):

```sh
$ yarn add computed-property
```

## Usage

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

## API

### [computedProperty](index.js#L99)

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**

```js
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](../../issues/new).

### Contributors

| **Commits** | **Contributor** |  
| --- | --- |  
| 10 | [doowb](https://github.com/doowb) |  
| 7  | [pgilad](https://github.com/pgilad) |  

### Building docs

_(This project's readme.md is generated by [verb](https://github.com/verbose/verb-generate-readme), please don't edit the readme directly. Any changes to the readme must be made in the [.verb.md](.verb.md) readme template.)_

To generate the readme, run the following command:

```sh
$ 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:

```sh
$ npm install && npm test
```

### Author

**Brian Woodward**

* [github/doowb](https://github.com/doowb)
* [twitter/doowb](https://twitter.com/doowb)

### License

Copyright © 2017, [Brian Woodward](https://github.com/doowb).
Released under the [MIT License](LICENSE).

***

_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.6.0, on June 03, 2017._