Tiny, secure, URL-friendly unique string ID generator using a larger alphabet for shorter IDs. Includes optimized functions for performance, customizable parameters, and support for various random generation methods.
Forked and migrated to Kotlin Multiplatform from original Kotlin implementation: viascom/nanoid-kotlin
A tiny, secure, URL-friendly, unique string ID generator for Kotlin.
“An amazing level of senseless perfectionism, which is simply impossible not to respect.”
Add nanoid-kotlin as a dependency to your project.
Gradle:
dependencies {
implementation("io.voxkit:nanoid:1.2.0")
}
Start using it:
val id = NanoId.generate()
val idWithCustomLength = NanoId.generate(10)
val idWithCustomAlphabet = NanoId.generate(alphabet = "ABC123")
If you change the alphabet of the NanoId.generate() function, you could optimize the performance by calculating a new additional
bytes factor with the following function:
val bytesFactor = NanoId.calculateAdditionalBytesFactor("ABC123")
val id = NanoId.generate(21, "ABC123", bytesFactor)
Utilizing a custom-calculated additional bytes factor in NanoId.generate() enhances string generation performance. This factor
determines how many bytes are generated in a single batch, optimizing computational efficiency. Generating an optimal number
of bytes per batch minimizes redundant operations and conserves memory.
NanoId.generateOptimized()The NanoId.generateOptimized() function is an advanced version of the NanoId.generate() function designed for higher performance and
lower memory overhead. While it provides a more efficient mechanism to generate unique identifiers, it assumes that you
know precisely how you want to use it.
🚫 Warning: No checks are performed inside NanoId.generateOptimized(). Use it only if you're sure about the parameters you'
re passing.
Generate a NanoId String of length 10 using the default alphabet set:
val id = NanoId.generateOptimized(10, "_-0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ", 63, 16)
By following this guide, you can seamlessly integrate the NanoId.generateOptimized() function into your projects and enjoy the
benefits of its optimized performance.
🐛 Encountered a Bug? Let us know with an issue. Every bit of feedback helps enhance the project.
💡 Interested in Contributing Code? Simply fork and submit a pull request. Every contribution, no matter its size, is valued.
📣 Have Some Ideas? We're always open to suggestions. Initiate an issue for discussions or to share your insights.
All relevant details about the project can be found in this README.
Your active participation 🤝 is a cornerstone of nanoid-kotlin. Thank you for joining us on this journey.
See also the list of contributors who participated in this project. 💕
This project is licensed under the Apache License 2.0 - see the LICENSE file for details.
SecureRandom random generator for JVM/Android, SecRandomCopyBytes for Apple,
crypto.getRandomValues for JS/WasmJS, /dev/urandom for Linux, BCryptGenRandom for Windows.A-Za-z0-9_-). So ID size was reduced from 36 to 21 symbols.Surfaced from shared tags and platforms — no rankings paid for.