Installation
Using npm:
npm install @gden/enumImport the package in your ES6 project:
import { Enum } from '@gden/enum';or require it with CommonJS:
const { Enum } = require('@gden/enum');Usage
import { Enum } from '@gden/enum';
const Colour = new Enum(['Green', 'Blue', 'Yellow']);Optionally, you can register Enum to make it available on the global or window object:
/**
* @param {String} key - defaults to "Enum"
*/
Enum.register(key);API
/**
* @param {Array|Object} entries
* @param {Object|String} options (optional)
*/
new Enum(entries, options);Entries
Every new instantiation of an Enum requires an array of strings or an object with key => value pairs.
Create a new Enum with an array:
new Enum(['Green', 'Blue', 'Yellow']);Create a new Enum with an object:
new Enum({ Green: 0, Blue: 1, Yellow: 2 });Options
Optionally, you can pass an options object to the constructor.
const options = {
/**
* The name of the Enum
* @type String
*/
name: undefined,
/**
* Case-insensitive access to Enum entries
* @type Boolean
*/
ignoreCase: false
};Examples
const Colour = new Enum({ Green: 0, Blue: 1, Yellow: 2 });
/**
* Get the EnumEntry direct
* @returns {EnumEntry} { key: 'Green', value: 0 }
*/
Colour.Green;
/**
* Get the EnumEntry by calling `get` method with a key
* @returns {EnumEntry} { key: 'Green', value: 0 }
*/
Colour.get('Green');
/**
* Get the EnumEntry by calling `get` method with a value
* @returns {EnumEntry} { key: 'Green', value: 0 }
*/
Colour.get(0);
/**
* Get the EnumEntry key by calling `getKey` method
* @returns {String} 'Green'
*/
Colour.getKey('Green');
// or
Colour.getKey(0);
/**
* Get the EnumEntry value by calling `getValue` method
* @returns {Number} 0
*/
Colour.getValue(0);
// or
Colour.getValue('Green');
/**
* Trying to access an EnumEntry that doesn't exist directly
* @returns undefined
*/
Colour.Red;
/**
* Trying to access an EnumEntry that doesn't exist using the `get` method
* @throws {ReferenceError} "Red" is not a valid enum entry key
*/
Colour.get('Red');