Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/paficent/enumerator
Robust Luau Module For Managing Enums
https://github.com/paficent/enumerator
enum enumerator lua luau module roblox
Last synced: about 2 months ago
JSON representation
Robust Luau Module For Managing Enums
- Host: GitHub
- URL: https://github.com/paficent/enumerator
- Owner: Paficent
- License: mit
- Created: 2024-09-08T03:29:10.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2024-09-19T12:31:23.000Z (4 months ago)
- Last Synced: 2024-10-12T08:21:04.387Z (3 months ago)
- Topics: enum, enumerator, lua, luau, module, roblox
- Language: Luau
- Homepage: https://paficent.github.io/Enumerator/
- Size: 1.13 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Enumerator - Robust Luau Enum Management
## Installation
Install enumerator via [wally](https://wally.run)
```toml
# wally.toml
[dependencies]
Enum = "paficent/[email protected]"
```
```shell
$ wally install
```
## Overview
Enumerator is a flexible and efficient module designed for managing enumerations in Luau projects. It provides a clean and structured approach to do enum management and enhance code clarity.
## Features
- **Fully Typed:** Enumerator ensures robust and type-safe management of enums in your project. (You'll need [wally-package-types](https://github.com/JohnnyMorganz/wally-package-types) to make full use of this module's type safety)
- **Structured Enum Definitions:** Enumerator allows organized definition of enums with associated names and values.
- **Retrieval Methods:** Enumerator provides straightforward and robust methods for retrieving enums.
## Documentation
For detailed information on how to use the Enumerator module, including API references and usage examples, visit the [Enumerator Documentation](https://paficent.github.io/Enumerator/).
## Contributions
Contributions are welcome and greatly appreciated. Feel free to open issues, submit feature requests, or create pull requests to help enhance the module.
## License
Enumerator is licensed under the MIT License. For more details, see the [LICENSE.md](https://github.com/Paficent/Enumerator/blob/main/LICENSE) file.