useful-enum v1.0.1

Useful Enum

Not just a silly object that holds onto silly values.

Usage

import { Enum, withEnum } from 'useful-enum';

const daysOfTheWeek = new Enum('DAYS_OF_THE_WEEK',
    'Sunday', 'Monday', 'Tuesday', 'Wednesday',
    'Thursday', 'Friday', 'Saturday'
);

const dinnersWithMom = withEnum({
    name: 'Dinner with Mom',
    day: daysOfTheWeek.Sunday,
    repeats: true
});

// this is fine
dinnersWithMom.day = daysOfTheWeek.Saturday; 

// this is not fine
// throws an error since dinnersWithMom.day is an enumerated value
dinnersWithMom.day = "Someday soon";

Null-ish Values

The value of an enumerated property can also be 'null-ish'.

import { Enum, withEnum } from 'useful-enum';

const daysOfTheWeek = new Enum('DAYS_OF_THE_WEEK',
    'Sunday', 'Monday', 'Tuesday', 'Wednesday',
    'Thursday', 'Friday', 'Saturday'
);

const dinnersWithMom = withEnum({
    name: 'Dinner with Mom',
    day: daysOfTheWeek.Sunday,
    repeats: true
});

// no more dinners with Mom
dinnersWithMom.day = daysOfTheWeek.notSet();

// resolves to `true`
dinnersWithMom.day.hasNoValue();

// resolves to `null`
dinnersWithMom.day.valueOf();