https://github.com/paulondc/enum-support
Support for enums in javascript
https://github.com/paulondc/enum-support
Last synced: 3 months ago
JSON representation
Support for enums in javascript
- Host: GitHub
- URL: https://github.com/paulondc/enum-support
- Owner: paulondc
- License: mit
- Created: 2016-03-31T09:25:56.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2018-10-02T03:08:56.000Z (over 6 years ago)
- Last Synced: 2025-02-17T12:38:11.883Z (4 months ago)
- Language: JavaScript
- Homepage:
- Size: 26.4 KB
- Stars: 0
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://travis-ci.org/paulondc/enum-support) [](https://codecov.io/github/paulondc/enum-support?branch=master)
This modules provides a fairly simple interface for enums in javascript. The enum object in this implementation is created through a plain object where the keys are required to be defined by either a string in "Capital" or "UPPERCASE" and the values are required to be defined numerically. Also, this module makes sure that an enum does not have duplicated values among its members.
## Requirement
This module requires support for [ES6](http://es6-features.org)
## Install
```
npm install enum-support --save
```
## Usage
Creating an Enum
```javascript
const Enum = require('enum-support');
var Enum = new Enum({"A": 1, "B": 2});
```
---
Accessing the enum
```javascript
// returns the value of A (1)
MyEnum.A;
// returns the value of B (2)
MyEnum.B;
```
---
Checking if a key or value is part of the enum
```javascript
// C is not part of the enum, returns false
MyEnum.has("C");
// Also, the value can be used to check if that is part of the enum, returns true
MyEnum.has(1);
```
---
Querying key and value from the enum
```javascript
// querying key from a value, returns "A"
MyEnum.key(1);
// querying value from a key, returns 1
MyEnum.value("A");
```
---
Querying enum contents
```javascript
// Retuns a list containing the keys, returns ["A", "B"]
MyEnum.keys;
// Retuns a list containing the values, returns [1, 2]
MyEnum.values;
```
## Example
```javascript
const assert = require("assert");
const Enum = require('enum-support');
class Pet {
constructor(specie){
assert(Pet.Specie.has(specie), "Invalid Specie!");
// printing the name of the specie
console.log(Pet.Specie.key(specie));
}
}
// adding the enum as static member of the class
Pet.Specie = new Enum({"Dog": 1, "Cat": 2});
// using it
var myPet = new Pet(Pet.Specie.Dog);
```
## Licensing
enum-support is free software; you can redistribute it and/or modify it under the terms of the MIT License