SSID Generator is a Node.js module that provides a secure and efficient way to generate short IDs, suitable for various use cases such as unique identifiers in databases, session IDs, URL shorteners, etc.
- Generates short IDs using a secure algorithm.
- Customizable length for generated IDs.
- Supports a wide range of characters, making IDs URL-friendly.
- Generate short IDs with prefix and suffix
- Generate short IDs with timestamps
- Ensures uniqueness of generated IDs, even in high-demand scenarios.
- Suitable for applications where security and uniqueness are critical.
- Optionally includes or excludes symbols based on your requirements.
You can install the Secure Short ID Generator module via npm:
npm install ssidconst { ssid } = require("ssid"); const shortId = ssid(); console.log("Short ID : ", shortId); // Short ID : h7g6fb-nconst { ssid, ssidWithAffixes, ssidWithTimestamp } = require("ssid"); const customAlphabet = "abcdefghijklmnopqrstuvwxyz1234567890"; const shortId = ssid(8, customAlphabet); console.log("Short ID : ", shortId); // Short ID : 9gHs8b1m const shortId = ssidWithAffixes(11, "ssid-"); console.log("Short ID : ", shortId); // Short ID : ssid-b7shdn const customAlphabet = "abcdefghijklmnopqrstuvwxyz1234567890"; const shortId = ssidWithAffixes(8, "2025", "", customAlphabet); console.log("Short ID : ", shortId); // Short ID : 2025dh2n const shortId = ssidWithTimestamp(11); console.log("Short ID : ", shortId); // Short ID : 1738479600000-bsh89mH2VAO const customAlphabet = "abcdefghijklmnopqrstuvwxyz1234567890"; const shortId = ssidWithTimestamp(8, customAlphabet); console.log("Short ID : ", shortId); // Short ID : 1738490400000-8NbSm10H| Parameter | Type | Default | Description |
|---|---|---|---|
length | Number | DEFAULT_LENGTH | The length of the generated ID. Minimum length is 4. |
customAlphabet | String | DEFAULT_ALPHABET | A custom set of characters to use for generating the ID. |
ssidWithAffixes(length = DEFAULT_LENGTH(8), prefix, suffix, customAlphabet = DEFAULT_ALPHABET(a-zA-Z0-9_-))
| Parameter | Type | Default | Description |
|---|---|---|---|
length | Number | DEFAULT_LENGTH | The length of the generated ID (prefix+suffix). Minimum length is 4. |
prefix | String | A string to prepend to the generated ID. Either prefix or suffix must be provided. | |
suffix | String | A string to append to the generated ID. Either prefix or suffix must be provided. | |
customAlphabet | String | DEFAULT_ALPHABET | A custom set of characters to use for generating the ID. |
| Parameter | Type | Default | Description |
|---|---|---|---|
length | Number | DEFAULT_LENGTH | The length of the short ID other than timestamp. Minimum length is 4. |
customAlphabet | String | DEFAULT_ALPHABET | A custom set of characters to use for generating the ID. |
This project is licensed under the MIT License.
