# attr-accessor

> Convenience factories for creating getter/setters

Latest version **0.2.2** (published 2015-06-28) · MIT license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install attr-accessor
pnpm add attr-accessor
yarn add attr-accessor
bun add attr-accessor
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 0.2.2 |
| Published | 2015-06-28 |
| First published | 2014-09-06 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 3 |
| Author | Tim Kurvers |
| Maintainers | timkurvers |
| Keywords | attr, accessor, reader, writer, getter, setter |

## Links

- npm: https://www.npmjs.com/package/attr-accessor
- Repository: https://github.com/timkurvers/attr-accessor
- Issues: https://github.com/timkurvers/attr-accessor/issues
- npm.io page: https://npm.io/package/attr-accessor

## Recent versions

- 0.2.2 (latest) — 2015-06-28
- 0.2.1 — 2014-11-09
- 0.2.0 — 2014-09-21
- 0.1.1 — 2014-09-20
- 0.1.0 — 2014-09-20
- 0.0.1 — 2014-09-20
- 0.0.0 — 2014-09-06

## README

# Attr Accessor

[![Version](https://img.shields.io/npm/v/attr-accessor.svg?style=flat)](https://www.npmjs.org/package/attr-accessor)
[![Build Status](https://img.shields.io/travis/timkurvers/attr-accessor.svg?style=flat)](https://travis-ci.org/timkurvers/attr-accessor)
[![Dependency Status](https://img.shields.io/gemnasium/timkurvers/attr-accessor.svg?style=flat)](https://gemnasium.com/timkurvers/attr-accessor)
[![Code Climate](https://img.shields.io/codeclimate/github/timkurvers/attr-accessor.svg?style=flat)](https://codeclimate.com/github/timkurvers/attr-accessor)
[![Coverage](https://img.shields.io/codeclimate/coverage/github/timkurvers/attr-accessor.svg?style=flat)](https://codeclimate.com/github/timkurvers/attr-accessor)

Convenience factories for creating getter/setters.

Licensed under the **MIT** license, see LICENSE for more information.


## Installation

Attr Accessor is available via [npm](https://www.npmjs.org/package/attr-accessor):

```shell
npm install attr-accessor
```

Or for usage in the browser:

- `dist/attr-accessor.js`
- `dist/attr-accessor.min.js`


## Usage

Pass in an object to `attr.reader` or `attr.writer` to obtain a getter or setter
factory respectively:

```javascript
get = attr.reader(object)
set = attr.writer(object)
```

ES2015 (ES6) [introduced classes](http://babeljs.io/docs/learn-es2015/#classes)
and has support for getter/setters.

CoffeeScript, on the other hand, has had no elegant way of defining getter/setters,
until now. Use its destructuring syntax in combination with `attr.accessor` to
obtain both factories:

```javascript
[get, set] = attr.accessor(object)
```

Use `attr.accessors` when dealing with classes to obtain two prototypal /
instance-bound factories as well as two static factories:

```javascript
[get, set, @get, @set] = attr.accessors(object)
```


### Example

```coffeescript
class Person
  [get, set, @get, @set] = attr.accessors(this)

  group = []

  constructor: (@firstName, @lastName) ->
    group.push this

  get name: ->
    "#{@firstName} #{@lastName}"

  @get count: ->
    group.length
```

```coffeescript
new Person('John', 'Doe').name # John Doe
Person.count # 1
```


## Development & Contribution

Attr Accessor is written in [ES2015](https://babeljs.io/docs/learn-es2015/), compiled by [Babel](https://babeljs.io/), developed with [Gulp](http://gulpjs.com/) and tested through [Mocha](http://mochajs.org/).

Getting this toolchain up and running, is easy and straight-forward:

1. Get the code:

   ```
   git clone git://github.com/timkurvers/attr-accessor.git
   ```

2. Download and install [Node.js](http://nodejs.org/#download) (includes `npm`) for your platform.

3. Install dependencies:

   ```shell
   npm install
   ```

4. Run `gulp` which will automatically build and test the project when source files change.

   When not available, run `./node_modules/.bin/gulp` instead.


When contributing, please:

* Fork the repository
* Accompany each logical unit of operation with at least one test
* Open a pull request
* Do *not* include any distribution files (such as `dist/attr-accessor.js`)

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