Nanoid
v2.1.0

View Source Nanoid (Nanoid v2.1.0)

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.

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.

Summary

Functions

generate()

Generates a secure NanoID using the default alphabet.

generate(size)

Generates a secure NanoID using the default alphabet.

generate(size, alphabet)

Generates a secure NanoID using a custom size and an individual alphabet.

generate_non_secure()

Generates a non-secure NanoID using the default alphabet.

generate_non_secure(size)

Generates a non-secure NanoID using the default alphabet.

generate_non_secure(size, alphabet)

Generate a non-secure NanoID using a custom size and an individual alphabet.

Functions

Link to this function

generate()

View Source 
@spec generate() :: binary()

Generates a secure NanoID using the default alphabet.

Example

Generate a NanoID with the default size of 21 characters. iex> Nanoid.generate() "mJUHrGXZBZpNX50x2xkzf"

Link to this function

generate(size)

View Source 
@spec generate(non_neg_integer()) :: binary()

Generates a secure NanoID using the default alphabet.

Example

Generate a secure NanoID with a custom size of 64 characters. iex> Nanoid.generate(64) "wk9fsUrhK9k-MxY0hLazRKpcSlic8XYDFusks7Jb8FwCVnoQaKFSPsmmLHzP7qCX"

Link to this function

generate(size, alphabet)

View Source 
@spec generate(non_neg_integer(), binary()) :: binary()

Generates a secure NanoID using a custom size and an individual alphabet.

Example

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

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

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

iex> Nanoid.generate(64, "abcdef123")
"aabbaca3c11accca213babed2bcd1213efb3e3fa1ad23ecbf11c2ffc123f3bbe"
Link to this function

generate_non_secure()

View Source 
@spec generate_non_secure() :: binary()

Generates a non-secure NanoID using the default alphabet.

Example

Generate a non-secure NanoID with the default size of 21 characters.

iex> Nanoid.generate_non_secure()
"mJUHrGXZBZpNX50x2xkzf"
Link to this function

generate_non_secure(size)

View Source 
@spec generate_non_secure(non_neg_integer()) :: binary()

Generates a non-secure NanoID using the default alphabet.

Example

Generate a non-secure NanoID with a custom size of 64 characters.

iex> Nanoid.generate_non_secure(64)
"wk9fsUrhK9k-MxY0hLazRKpcSlic8XYDFusks7Jb8FwCVnoQaKFSPsmmLHzP7qCX"
Link to this function

generate_non_secure(size, alphabet)

View Source 
@spec generate_non_secure(non_neg_integer(), binary() | any()) :: binary()

Generate a non-secure NanoID using a custom size and an individual alphabet.

Example

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

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

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

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