Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/draviavemal/alias-key-gen
tracked unique key generator
https://github.com/draviavemal/alias-key-gen
alias aliases hash
Last synced: about 1 month ago
JSON representation
tracked unique key generator
- Host: GitHub
- URL: https://github.com/draviavemal/alias-key-gen
- Owner: DraviaVemal
- License: mit
- Created: 2024-05-01T06:07:27.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2024-05-06T07:46:03.000Z (8 months ago)
- Last Synced: 2024-11-13T09:53:43.692Z (about 2 months ago)
- Topics: alias, aliases, hash
- Language: TypeScript
- Homepage:
- Size: 83 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Alias Key Generator
This package enables the generation of unique alias name . The default UID generated are considred for SQL keywords to avoid query conflict.
End user can update the options to configure as per the need
## Installation
You can install this package via npm:
```bash
npm i alias-key-gen
```
## Usage
```javascript
import { AliasKeyGen } from "alias-key-gen";
const aliasKeyGen = new AliasKeyGen({
charString: "abcdfghjkmpqxz",
extendNumberSequenceSuffix: {
enableNumSeq: true,
maxNumberSeq: 9
},
startSequence: "ab5"
});
console.log(aliasKeyGen.next());
console.log(aliasKeyGen.next());
```
```bash
# Output is
a
b
```
## Contribution
Contributions are welcome! If you encounter issues or have suggestions for improvements, feel free to open an issue or submit a pull request on [GitHub](https://github.com/DraviaVemal/alias-key-gen/pulls).
## License
This package is licensed under the MIT License.
## Contact
For inquiries or support, please contact [[email protected]](mailto:[email protected]).