typed-enum v0.1.1

typed-enum

Enum Factory in Typed JavaScript.

Install

npm install typed-enum

Usage

Import

CommonJS (Node.js), AMD (RequireJS), CMD (Sea.js)

var Enum = require('typed-enum/dist/enum.min.js')

Naked script

<script src='typed-enum/dist/enum.min.js'></script>
<script>
var Enum = MY_MODULES['typed-enum'].exports
</script>

API

var Sex = Enum('male', 'female')

//all expressions return true
Sex.MALE instanceof Sex && Sex.FEMALE instanceof Sex
Sex.MALE.value === 'male' && Sex.FEMALE.value === 'female'
Sex.MALE == 'male' && Sex.FEMALE == 'female'
JSON.stringify(Sex.MALE) === '"male"' && JSON.stringify(Sex.FEMALE) === '"female"'
Sex.has('male') && Sex.has('female') && !Sex.has('foo')
Sex('male') === Sex.MALE && Sex('female') === Sex.FEMALE