@csduck/enum

@csduck/enum is a utility library that provides a way to create and use enums in JavaScript and TypeScript. It allows you to define enums with a simple and readable syntax and provides a set of utility functions to work with them. This library is part of the csduck libraries collection.

Table of Contents

• Installation
• Usage
• Contribution
• License

Installation

You can install this library using npm or yarn:

npm install @csduck/enum
# or
yarn add @csduck/enum

Usage

You can define an enum using the EnumDef class.

Example:

const EColors = new EnumDef(["RED", "BLUE", "GREEN", "YELLOW"]);

After you defined an enum, you can use the Enum class to work with it.

Methods

Enum.options: string[]

Returns an array of all the enum options.

const EColors = new EnumDef(["RED", "BLUE", "GREEN", "YELLOW"]);

console.log(EColors.options);
// Result: ["RED", "BLUE", "GREEN", "YELLOW"]

Enum.records: Record<string, string>

Returns an object with the enum options as keys and values.

const EColors = new EnumDef(["RED", "BLUE", "GREEN", "YELLOW"]);

console.log(EColors.records);
// Result: { RED: "RED", BLUE: "BLUE", GREEN: "GREEN", YELLOW: "YELLOW" }

const myColor = EColors.RED;

Contribution

Contributions and bug reports are welcome! Feel free to open issues or submit pull requests on the GitHub repository.

License

This project is licensed under the MIT License. See the LICENSE file for details.