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

@ngekoding/enum

v1.1.1

Published

Utility library for working with enumerated types (enums)

Downloads

4

Readme

Enum

A utility library for working with enumerated types (enums). Simplify the management of constant values by creating strongly-typed enums with custom labels and values. Provides convenience methods for enum conversion, retrieval, and equality checks.

Inspired by PHP Enum.

Installation

npm install @ngekoding/enum

Usage

This is how an enum can be defined.

import Enum from '@ngekoding/enum'

class UserLevel extends Enum {
  static Basic = new UserLevel(1, 'Basic')
  static Pro = new UserLevel(2, 'Pro')
  static Premium = new UserLevel(3, 'Premium')
}

Where the first parameter is the value and the second parameter is the label.

Accessing enum values or labels

console.log(UserLevel.Basic.value) // Output: 1
console.log(UserLevel.Basic.label) // Output: Basic

Creating an enum from a value

const userLevel = UserLevel.fromValue(2)

When an enum value doesn't exist, you'll get an Error exception. If you would prefer not catching an exception, you can use:

const userLevel = UserLevel.tryFromValue(2)

When an enum value doesn't exist in this case, userLevel will have value null and label Unknown.

Comparing enums

Enums can be compared using the equals method:

console.log(userLevel.equals(UserLevel.Pro)) // Output: true

You can pass several enums to the equals method, it will return true if the current enum equals one of the given values.

console.log(userLevel.equals(UserLevel.Pro, UserLevel.Premium)) // Output: true

You can safely comparing enum even there is no enum value when using tryFromValue.

console.log(UserLevel.tryFromValue(0).equals(UserLevel.Basic)) // Output: false

Get an array of enum instances

You can get an array containing all the enum instances defined within the enum class. This is allows easy access to the entire set of enum values.

const values = UserLevel.values()
console.log(values) // Output: [UserLevel.Basic, UserLevel.Pro, UserLevel.Premium]