https://github.com/sanyampunia/unique-forge

🔐 Customizable, secure ID generator with async support and prefix/suffix options for JS/TS
https://github.com/sanyampunia/unique-forge

collision forge generator nanoid unique-id

Last synced: 1 day ago
JSON representation

🔐 Customizable, secure ID generator with async support and prefix/suffix options for JS/TS

• Host: GitHub
• URL: https://github.com/sanyampunia/unique-forge
• Owner: SanyamPunia
• License: other
• Created: 2024-12-05T10:45:01.000Z (2 months ago)
• Default Branch: main
• Last Pushed: 2024-12-05T10:55:09.000Z (2 months ago)
• Last Synced: 2025-01-05T00:45:30.049Z (30 days ago)
• Topics: collision, forge, generator, nanoid, unique-id
• Language: TypeScript
• Homepage: https://www.npmjs.com/package/unique-forge
• Size: 109 KB
• Stars: 5
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
## UniqueForge

Customizable and secure ID generator with async and prefix/suffix support for JS/TS environment.

### Installation

```bash

npm install unique-forge

```

### Usage

#### Basic ID Generation

Use `UniqueForge` for standard unique ID generation:

```js

const { UniqueForge } = require('unique-forge');

const forge = new UniqueForge();

console.log(forge.generate()); // Outputs a unique ID

```

#### Asynchronous ID Generation

For asynchronous workflows, use `AsyncUniqueForge`:

```js

const { AsyncUniqueForge } = require('unique-forge');

const asyncForge = new AsyncUniqueForge();

asyncForge.generate().then((id) => console.log(id));

```

#### Secure ID Generation

For cryptographically secure IDs, use `SecureUniqueForge`:

```js

const { SecureUniqueForge } = require('unique-forge');

const secureForge = new SecureUniqueForge();

console.log(secureForge.generate()); // Outputs a secure unique ID

```

#### Customizable ID Generation

Use `CustomUniqueForge` for IDs with custom prefixes or suffixes:

```js

const { CustomUniqueForge } = require('unique-forge');

const customForge = new CustomUniqueForge({ prefix: 'user_', suffix: '_2023' });

console.log(customForge.generate()); // Outputs: user__2023

```

### Features

- **Customizable Alphabet**: Define your own characters for ID generation.

- **Adjustable Length**: Set the size of the generated IDs.

- **Synchronous & Asynchronous**: Flexible workflows for various use cases.

- **Secure Random ID**s: Leverage cryptographic randomness when needed.

- **Prefix/Suffix Support**: Easily create formatted IDs.

### License

This library is [MIT](/LICENSE) Licensed. Contributions are welcome!