# computed-property

> Add computed properties to JavaScript objects.

Latest version **1.0.0** (published 2017-06-03) · MIT license · 0 weekly downloads

## Install

```sh
npm install computed-property
pnpm add computed-property
yarn add computed-property
bun add computed-property
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2017-06-03 |
| First published | 2014-11-19 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=0.10.0 |
| Dependencies | 3 |
| Known vulnerabilities | 0 (+2 in 1 direct dependencies) |
| Install scripts | no |
| Author | Brian Woodward |
| Maintainers | doowb |
| Keywords | docs, documentation, generate, generator, markdown, templates, verb |

## Links

- npm: https://www.npmjs.com/package/computed-property
- Repository: https://github.com/doowb/computed-property
- Issues: https://github.com/doowb/computed-property/issues
- npm.io page: https://npm.io/package/computed-property

## Dependencies (3)

- [get-value](https://npm.io/package/get-value.md) ^0.3.2
- [set-value](https://npm.io/package/set-value.md) ^1.0.0
- [clone-deep](https://npm.io/package/clone-deep.md) ^0.3.0

## Alternatives

- [@cantoo/pdf-lib](https://npm.io/package/@cantoo/pdf-lib.md) — 297.9K weekly downloads
- [datatables.net-buttons](https://npm.io/package/datatables.net-buttons.md) — 200.1K weekly downloads
- [@ckeditor/ckeditor5-export-pdf](https://npm.io/package/@ckeditor/ckeditor5-export-pdf.md) — 167.0K weekly downloads
- [scanbot-web-sdk](https://npm.io/package/scanbot-web-sdk.md) — 15.0K weekly downloads
- [@syncfusion/ej2-angular-pdfviewer](https://npm.io/package/@syncfusion/ej2-angular-pdfviewer.md) — 8.8K weekly downloads

## Recent versions

- 1.0.0 (latest) — 2017-06-03
- 0.1.3 — 2017-06-03
- 0.1.2 — 2014-12-18
- 0.1.1 — 2014-12-12
- 0.1.0 — 2014-11-19

## README

# 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._

---
_Source: https://npm.io/package/computed-property · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._