# glum

> JS enums with type safety

Latest version **0.2.2** (published 2020-01-22) · MIT license · 0 weekly downloads

## Install

```sh
npm install glum
pnpm add glum
yarn add glum
bun add glum
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.2.2 |
| Published | 2020-01-22 |
| First published | 2020-01-21 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Node | >=6.0.0 |
| Dependencies | 0 |
| Unpacked size | 17.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Ben Gubler |
| Maintainers | nebrelbug |
| Keywords | enum, type-safety, enums, glum enum |

## Links

- npm: https://www.npmjs.com/package/glum
- Repository: https://github.com/nebrelbug/glum
- Issues: https://github.com/nebrelbug/glum/issues
- npm.io page: https://npm.io/package/glum

## Recent versions

- 0.2.2 (latest) — 2020-01-22
- 0.2.1 — 2020-01-22
- 0.2.0 — 2020-01-22
- 0.1.0 — 2020-01-21

## README

# glum

[![styled with prettier](https://img.shields.io/badge/styled_with-prettier-ff69b4.svg)](https://github.com/prettier/prettier)
[![Travis](https://img.shields.io/travis/com/nebrelbug/glum/master.svg)](https://travis-ci.com/nebrelbug/glum)
[![Coveralls](https://img.shields.io/coveralls/nebrelbug/glum.svg)](https://coveralls.io/github/nebrelbug/glum)
[![Dev Dependencies](https://img.shields.io/david/dev/nebrelbug/glum)](https://david-dm.org/nebrelbug/glum?type=dev)
[![Donate](https://img.shields.io/badge/donate-paypal-blue.svg)](https://paypal.me/bengubler)

**Summary**

glum is a super lightweight Enum library that makes use of Symbols to achieve type-safety.

_What if my environment doesn't support ES6?_

If you're in a browser, use a polyfill.
If you're running in Node, chances are that Symbols are supported: they're supported in all versions after 5.12.0.

**Why use Glum?**

- Type-safety. When you declare an Enum, members are unique and can't be mimicked by strings, numbers, etc.
- Allows for passing in polyfills
- Don't reinvent the wheel

## :scroll: Docs

### Installation

```
npm install glum
```

Or, if in a browser,

```
<script crossorigin src="https://cdn.jsdelivr.net/npm/glum"></script>
```

[Note: this will create a global variable called Glum]

### Usage

We distribute a UMD build, so you can use it with ES modules, CommonJS, AMD, or in the browser

```js
import Enum from 'glum'
// or var Enum = require 'glum'

let FRUIT = new Enum('APPLE', 'ORANGE', 'PEAR')

function nameFruit (fruit) {
  if ((fruit = FRUIT.APPLE)) {
    console.log("It's an apple")
  }
}

console.log(FRUIT.getName(FRUIT.APPLE)) // APPLE
```

### API

#### `new Enum(... enumNames, [symbolPolyfill])`

Create a new Enum.
_Ex._ `let fruits = new Enum("APPLE", "ORANGE", "PEAR")`
_Ex. with polyfill_ `let fruits = new Enum("APPLE", "ORANGE", "PEAR", function(name) {return '@@\_Symbol:' + name})`

#### `Enum.has(member)`

Check if a member is part of an enum. **Note:** this will primarily be used to accept function parameters, variables, etc. that must be a member of a certain enum.
_Ex._

```js
let fruits = new Enum('APPLE', 'ORANGE', 'PEAR')
fruits.has(fruits.APPLE) // true
fruits.has(fruits.HI) // false
```

#### `Enum.getName(member)`

Get the name of an enum member. **Note:** this is usually used to get the name of an Enum member passed as a parameter, variable, etc.
_Ex._

```js
let fruits = new Enum('APPLE', 'ORANGE', 'PEAR')
fruits.getName(fruits.APPLE) // "APPLE"
```

## :heavy_check_mark: Tests

Tests can be run with `npm test`. Multiple tests check that things return expected results, formatting follows guidelines, and code coverage is at the expected level.

## Projects using `glum`

Create an issue to add yours!

## Credits

Made with :heart: by [@nebrelbug](https://github.com/nebrelbug) and all these wonderful contributors ([emoji key](https://github.com/kentcdodds/all-contributors#emoji-key)):

<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
<!-- prettier-ignore -->
<!-- ALL-CONTRIBUTORS-LIST:END -->

This project follows the [all-contributors](https://github.com/kentcdodds/all-contributors) specification. Contributions of any kind are welcome!

---
_Source: https://npm.io/package/glum · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._