es6-enum/README.md

Enum type made by es6

# es6-enum

[![Version](http://img.shields.io/npm/v/es6-enum.svg)](https://www.npmjs.org/package/es6-enum)
[![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat)](https://github.com/feross/standard)
[![npm download][download-image]][download-url]
[![Circle CI](https://circleci.com/gh/wwayne/es6-enum/tree/master.svg?style=svg)](https://circleci.com/gh/wwayne/es6-enum/tree/master)

[download-image]: https://img.shields.io/npm/dm/es6-enum.svg?style=flat-square
[download-url]: https://npmjs.org/package/es6-enum

### Installation

```sh
npm install es6-enum
```

### Usage

```javascript
import Enum from "es6-enum"

const ORIENTATION = Enum("NORTH", "SOUTH", "WEST", "EAST")
const ORIEN = Enum("NORTH", "SOUTH", "WEST", "EAST")

typeof ORIENTATION.NORTH                      // "symbol"

ORIENTATION.NORTH === ORIENTATION.NORTH       // true
ORIENTATION.NORTH === ORIEN.NORTH             // false

export ORIENTATION
```

### In practice
I like use this package to define **constant** in **Redux**

```javascript
constant.js
  const APPLICATION = Enum('USER')

action.js
  dispatch({
    type: APPLICATION.USER,
    data
  })

reducer.js
  [APPLICATION.USER]: (state, action) => {
    ...
  }

```


### License

MIT