Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/chasefleming/enum-xyz
Flexible JavaScript enums using ES6 Proxies.
https://github.com/chasefleming/enum-xyz
enum enums javascript
Last synced: 2 months ago
JSON representation
Flexible JavaScript enums using ES6 Proxies.
- Host: GitHub
- URL: https://github.com/chasefleming/enum-xyz
- Owner: chasefleming
- Created: 2022-02-15T04:03:25.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2023-08-23T00:06:50.000Z (over 1 year ago)
- Last Synced: 2024-10-24T04:45:37.934Z (2 months ago)
- Topics: enum, enums, javascript
- Language: JavaScript
- Homepage:
- Size: 614 KB
- Stars: 40
- Watchers: 3
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# enum-xyz
`enum-xyz` offers a way to generate enums in JavaScript leveraging the power of Proxies. It supports various casing styles, transformations, and other customization options.
> Based on [this tweet](https://twitter.com/2ality/status/1486139713354448897)
[](https://github.com/chasefleming/enum-xyz/actions/workflows/integrate.yml)
> Note: This library is not yet at version 1.0.0. As such, breaking changes may occur in subsequent releases. Please ensure you read the release notes when updating.
## Install
```
$ npm install enum-xyz --save
```
## Usage
### String Enums
```
import Enum from "enum-xyz";
const { Summer, Autumn, Winter, Spring } = Enum.String();
console.log(Summer); // Outputs: "Summer"
```
#### Options for String Enums:
- `casing`: Transforms the string based on the specified casing style. Available options are `snakeCase`, `camelCase`, `PascalCase`, `kebabCase`, `lowercase`, and `uppercase`.
- `transform`: Provide a custom function to transform the enum values. This function takes the original value and returns a transformed value.
##### Example:
```
const { userId, userAddress } = Enum.String({ casing: 'kebabCase' });
console.log(userId); // Outputs: "user-id"
const options = {
casing: 'kebabCase',
transform: (value) => `https://api.example.com/${value}`
};
const { userEndpoint, orderEndpoint } = Enum.String(options);
console.log(userEndpoint); // Outputs: "https://api.example.com/user-endpoint"
```
### Numeric Enums
Starts from 0 by default:
```
import Enum from "enum-xyz";
const { A, B, C, D } = Enum.Numeric();
console.log(A); // Outputs: 0
```
#### Options for Numeric Enums:
- `startIndex`: Start the numeric enum from a specific index.
- `step`: Increment the numeric values by a specific step (e.g., 2, 5, 10).
##### Example:
```
const { A, B, C } = Enum.Numeric({ startIndex: 5, step: 2 });
console.log(A); // Outputs: 5
console.log(B); // Outputs: 7
```
### Symbol Enums
```
import Enum from "enum-xyz";
const { blue, red } = Enum.Symbol();
console.log(blue); // Outputs: Symbol(blue)
```
#### Options for Symbol Enums:
- `global`: Create a global symbol using Symbol.for().
##### Example:
```
const { blueGlobal } = Enum.Symbol({ global: true });
console.log(blueGlobal); // Outputs: Symbol.for('blueGlobal')
```