Enum-support NPM

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

Install

npm install enum-support --save

Usage

Creating an Enum

const Enum = require('enum-support');

var Enum = new Enum({"A": 1, "B": 2});

Accessing the enum

// 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

// 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

// querying key from a value, returns "A"
MyEnum.key(1);

// querying value from a key, returns 1
MyEnum.value("A");

Querying enum contents

// Retuns a list containing the keys, returns ["A", "B"]
MyEnum.keys;

// Retuns a list containing the values, returns [1, 2]
MyEnum.values;

Example

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);