npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2025 – Pkg Stats / Ryan Hefner

enum.js

v0.1.0

Published

Tiny vanilla JS library for creating enumerations

Downloads

3

Readme

enum.js

Tiny vanilla JS library for creating enumerations.

Installation

Recommended way to install is via Bower:

bower install --save enumjs

or via NPM:

bower install --save enum.js

Note that package names are different for Bower and NPM.

If you aren't using Bower, just download it as zip.

Basic usage

First, define your enum:

Enum.define('Beverage', ['BEER', 'SODA', 'JUICE']);

Then you can access it through the global Beverage object:

console.log(Beverage.JUICE);

AMD/require

For AMD modules, the thing works a bit different.

// file Beverage.js
define(['enum'], function (Enum) {
  return new Enum(['BEER', 'SODA', 'JUICE']);
});
// another file
require(['Beverage'], function(Beverage) {
  console.log(Beverage.SODA);
});

Node

// file Beverage.js
var Enum = require('enum');

module.exports = new Enum(['BEER', 'SODA', 'JUICE']);
// another file
var Beverage = require('Beverage');

console.log(Beverage.BEER);

Cool tricks for cool kids

Every element has a .toString() method:
console.log(Beverage.SODA.toString()); // "SODA"
You can pass a custom toString function right after the list of elements:
Enum.define('Beverage', ['BEER', 'SODA', 'JUICE'], function (value) {
  
  switch(value) {
    case Beverage.BEER:
      return 'Tasty beer, 4,5% alcohol by volume';

    case Beverage.SODA:
      return 'Tasty soda, 0% alcohol by volume';

    case Beverage.JUICE:
      return 'Now this is healthy';
  }
});

console.log(Beverage.JUICE.toString()); // "Now this is healthy"

This is good for cases where you need to show a pretty value for the user based on your enum.

Get all the possible values for a given enum:
Object.keys(Beverage); // ["BEER", "SODA", "JUICE"]
Elements are immutable:

In NodeJS and modern browsers (IE9+), the enum elements are immutable:

Enum.define('Beverage', ['BEER', 'SODA', 'JUICE']);

Beverage.BEER = "I'm trying to override you";

console.log(Beverage.BEER.toString()); //"BEER", works normally

However, the global enum object (Beverage in our case) is still mutable.

Old browser gotchas

To ensure element immutability, enum.js relies on Object.freeze(). This method is not available for IE8 and below, so be aware if you need to support old browsers.

Testing

To test in NodeJS: jasmine

To test browser AMD/require behavior: karma start karma-amd.conf.js

To test common browser environment behavior: karma start

Full command: jasmine && karma start --single-run && karma start karma-amd.conf.js --single-run

Contributing

In case you have an improvement idea or found an "easter egg", open an issue.