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

symbol-enum

v4.0.3

Published

Enum with symbols

Downloads

1,150

Readme

SymbolEnum

Enum with symbols.

npm Build Status Coverage Status Dependency Status devDependency Status node

Usage

const SymbolEnum = require('symbol-enum')

#constructor(...keys)

Creates a new Enum with the specified keys.

const MyEnum = new SymbolEnum('a', 'b', 'c')

#[key]

Retrieves the symbol corresponding to the key.

const val = MyEnum.a
val // Symbol(a)

#[symbol]

Retrieves the key corresponding to the symbol.

MyEnum[val] // "a"

#[SymbolEnum.keys]()

Returns an iterator that can be used to iterate through the keys.

Array.from(MyEnum[SymbolEnum.keys]) // "[ a, b, c ]"

#[SymbolEnum.values]()

Returns an iterator that can be used to iterate through the values.

Array.from(MyEnum[SymbolEnum.values]) // "[ Symbol(a), Symbol(b), Symbol(c) ]"

#[SymbolEnum.has](key)

Returns whether the enum contains the specified key.

MyEnum[SymbolEnum.has]('b') // true

#[SymbolEnum.hasValue](value)

Returns whether the enum contains the specified value.

MyEnum[Symbol.hasValue](MyEnum.c) // true

#[SymbolEnum.size]

Returns the number of keys passed to the constructor.

'Underscore'd properties

For your convenience, the following properties are also available directly on the object itself, but only if you don't specify keys and values as a member of the enum itself.

  • #[SymbolEnum.keys] as keys
  • #[SymbolEnum.values] as values
  • #[SymbolEnum.has] as has
  • #[SymbolEnum.hasValue] as hasValue

If you do, underscores will be prepended to the property name until it becomes available. For example, if you added both keys and _keys in the Enum, #[SymbolEnum.keys] will also be available at #__keys.

Extends from null

SymbolEnum extends from null and does not have any string prototype methods so we have a clean slate. This means we don't inherit from Object and have any of its properties.

Exception: #constructor

Since we're using classes here, that means constructor will still be defined by default. No worries, if you specify constructor as a key, it will be overridden.

License

MIT