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 🙏

© 2024 – Pkg Stats / Ryan Hefner

enumitron

v0.0.2

Published

An enumeration class written in TypeScript

Downloads

2

Readme

Enumitron

https://img.shields.io/github/license/brybrophy/enumitron?color=blue https://img.shields.io/npm/v/enumitron https://img.shields.io/bundlephobia/minzip/enumitron https://img.shields.io/librariesio/release/npm/enumitron

Generate enumerations in many different forms.

This package can be used to create type-safe enumerations, and retrieve them as a dictionary, as an array of id's, as an array of names, or as an array of objects. You can also lookup a name by id.

Usage

import Enumitron from "enumitron";

const numbers = [
  { id: 1, name: "One" },
  { id: 2, name: "Two" },
];
const numbersEnum = new Enumitron(numbers);

Constraints

All enums are required to have unique names and ids. If there are objects with duplicate names or ids in the array that is passed into the Enumitron constructor, an error will be thrown.

Any additional key/value pairs contained in the objects you pass in will be preserved. The values can be of any type.

Getters

asDictionary

numbersEnum.asDictionary;
/* returns...
{
  One: { id: 1, name: 'One' },
  Two: { id: 2, name: 'Two' }
}
*/

asIds

numbersEnum.asIds;
// returns [1, 2]

asNames

numbersEnum.asNames;
// returns ['One', 'Two'];

asObjects

numbersEnum.asObjects;
// returns [{ id: 1, name: 'One' }, { id: 2, name: 'Two' }];

Methods

getNameById

numbersEnum.getNameById(1);
// returns 'One';

If a name is not found at the given id, an error will be thrown.

Additional Properties

You can include more than just id and name into an enumeration object. Whatever properties you include will be preserved and returned when enum.asObject or enum.asDictionary is called.

import Enumitron from "enumitron";

const numbers = [
  { id: 1, name: "One", translations: { german: "Ein", spanish: "Uno" } },
  { id: 2, name: "Two", translations: { german: "Zwei", spanish: "Dos" } },
];
const numbersEnum = new Enumitron(numbers);

numbersEnum.asObjects;
/* 
returns 
[
  { id: 1, name: "One", translations: { german: "Ein", spanish: "Uno" } },
  { id: 2, name: "Two", translations: { german: "Zwei", spanish: "Dos" } },
]
*/

Iteration

To make retrieval of enumerations more streamlined, the Enumitron class is implemented as a interable class. This allows you to access properties of the class at their indexes, and perform loops on the class.

For Loop

for (let i = 0; i < numbersEnum.length; i++) {
  doThingWithEnum(numbersEnum[i]);
}

For Of Loop

for (let item of numbersEnum) {
  doThingWithEnum(item);
}

Index Access

numbersEnum[1];
// returns { id: 2, name: 'Two' }