Instalation
npm install --save vanilla-enum# or with yarn yarn add vanilla-enum
Basic usage
Enum(object[, options])
const GENDER = Male: value: 1 description: "Male 🙋♂️" Female: value: 2 description: "Female 🙋♀️" ignoreCase: false // default GENDERMale // 1GENDER // "Female 🙋♀️"GENDERMale // "Male 🙋♂️"GENDERFemale // trueGENDERFemale // falseGENDERFemale // true
Options
name | type | default | description |
---|---|---|---|
ignoreCase | boolean | false | Ignore case when using the is function |
Custom properties
All properties added at the enum item object have getters
const GENDER = Male: value: 1 description: "🙋♂️" isSelected: true Female: value: 2 description: "🙋♀️" GENDER // trueGENDER // undefined
License
Vanilla Enum uses the MIT license.