nanoid.cr

Crystal implementation of original NanoID

Installation

Add this to your application's shard.yml:

dependencies:
  nanoid:
    github: mamantoha/nanoid.cr

Usage

require "nanoid"

Nanoid.generate uses URL-friendly symbols (A-Za-z0-9_-) and returns an ID with 21 characters.

Nanoid.generate
# => 3gFI8yZxcfXsXGhB0036l

If you want to reduce ID length (and increase collisions probability), you can pass the length as an argument.

Nanoid.generate(size: 8, alphabet: "1234567890abcdef")
# => 86984b57

Non-secure API is also available.

Nanoid.generate(secure: false)
# => no0MmiInNcBm9jR2_3sGt

Nanoid.generate(size: 10, alphabet: "1234567890abcdef", secure: false)
# => 2793b2351c

Benchmark

crystal run --release ./bench/benchmark.cr

Crystal 1.14.0 (2024-10-09)

LLVM: 19.1.1
Default target: aarch64-apple-darwin24.1.0

    Nanoid.simple_generate(21)   4.01  (249.32ms) (± 1.03%)  76.3MB/op   3.37× slower
   Nanoid.complex_generate(21)   3.48  (287.70ms) (± 1.19%)  91.6MB/op   3.89× slower
Nanoid.non_secure_generate(21)  13.53  ( 73.88ms) (± 6.65%)  45.8MB/op        fastest
                       UUID v4   3.88  (257.79ms) (± 4.41%)   168MB/op   3.49× slower
    Nanoid.simple_generate(36)   3.64  (274.49ms) (± 1.03%)   107MB/op   2.14× slower
   Nanoid.complex_generate(36)   2.98  (335.88ms) (± 2.10%)   122MB/op   2.62× slower
Nanoid.non_secure_generate(36)   7.80  (128.28ms) (± 3.71%)  61.0MB/op        fastest
                       UUID v4   3.82  (261.47ms) (± 2.15%)   168MB/op   2.04× slower

Development

Clone this repository and install dependencies:

shards install

Run tests:

crystal spec

Contributing

1. Fork it (https://github.com/mamantoha/nanoid.cr/fork)
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create a new Pull Request

Contributors

• mamantoha Anton Maminov - creator, maintainer

License

Copyright: 2018-2025 Anton Maminov (anton.maminov@gmail.com)

This library is distributed under the MIT license. Please see the LICENSE file.