@ncoderz/superenum/dist/docs/README.md

Simple, typesafe enums in TypeScript, fully compatible with standard JavaScript

**@ncoderz/superenum**

***

Simple, typesafe enums in TypeScript, fully compatible with standard JavaScript.

## API

* [superenum(objEnum)](interfaces/Superenum.md)
*  Superenum.fromObject superenum.fromObject(objEnum)
*  Superenum.fromArray superenum.fromArray(arrEnum)
*  EnumExtensions.fromValue \[enum\].fromValue(value, options?)
*  EnumExtensions.fromKey \[enum\].fromKey(key, options?)
*  EnumExtensions.keyFromValue \[enum\].keyFromValue(key, options?)
*  EnumExtensions.setMetadata \[enum\].setMetadata(value, metadata, options?)
*  EnumExtensions.getMetadata \[enum\].getMetadata(value, options?)
*  EnumExtensions.values \[enum\].values()
*  EnumExtensions.keys \[enum\].keys()
*  EnumExtensions.entries \[enum\].entries()

## License

This open source software is licenced under the [BSD-2-Clause licence](https://opensource.org/licenses/BSD-2-Clause).