Nanoid

v1.0.1

Nanoid v1.0.1 Nanoid View Source

Elixir port of NanoID (https://github.com/ai/nanoid), a tiny, secure URL-friendly unique string ID generator.

Safe. It uses cryptographically strong random APIs and guarantees a proper distribution of symbols.

Small. Only 179 bytes (minified and gzipped). No dependencies. It uses Size Limit to control size.

Compact. It uses a larger alphabet than UUID (A-Za-z0-9_~) and has a similar number of unique IDs in just 21 symbols instead of 36.

Link to this section Summary

Functions

generate(size \\ 21)

Generates a NanoID using the default alphabet.

Example

Generate a NanoID with the default size of 21 characters.

iex> Nanoid.generate()
"mJUHrGXZBZpNX50x2xkzf"
generate(size, alphabet)

Generate a NanoID using a custom size and an individual alphabet.

Example

Generate a NanoID with the default size of 21 characters and an individual alphabet.

iex> Nanoid.generate(21, "abcdef123")
"d1dcd2dee333cae1bfdea"

Link to this section Functions

Link to this function generate(size \\ 21) View Source 
generate(Integer.t()) :: String.t()

Generates a NanoID using the default alphabet.

Example

Generate a NanoID with the default size of 21 characters.

iex> Nanoid.generate()
"mJUHrGXZBZpNX50x2xkzf"

Generate a NanoID with a custom size of 64 characters.

iex> Nanoid.generate(64)
"wk9fsUrhK9k~MxY0hLazRKpcSlic8XYDFusks7Jb8FwCVnoQaKFSPsmmLHzP7qCX"
Link to this function generate(size, alphabet) View Source 
generate(Integer.t(), String.t()) :: String.t()

Generate a NanoID using a custom size and an individual alphabet.

Example

Generate a NanoID with the default size of 21 characters and an individual alphabet.

iex> Nanoid.generate(21, "abcdef123")
"d1dcd2dee333cae1bfdea"

Generate a NanoID with custom size of 64 characters and an individual alphabet.

iex> Nanoid.generate(64, "abcdef123")
"aabbaca3c11accca213babed2bcd1213efb3e3fa1ad23ecbf11c2ffc123f3bbe"