DarkMatter.ShortIds (DarkMatter v1.1.4) View Source

Generates a unique short_id for use in abreviated non-uuid id aliases.

Link to this section Summary

cipher()

key()

keys()

Decodes a given key from a unique short-id

Handles parsing the response

Handles parsing the response and raising an error in the event of failure

Encodes a given cipher to a unique short-id

cipher() :: String.t()

key() :: pos_integer()

keys() :: [pos_integer()]

options() :: [alphabet: binary(), salt: binary(), min_len: pos_integer()]

decode(cipher(), options()) :: {:ok, keys()} | :error

Decodes a given key from a unique short-id

## Examples

iex> decode("NY6")
{:ok, [5]}

decode_singular_cipher(cipher(), options()) :: {:ok, key()} | :error

Handles parsing the response

## Examples

iex> decode_singular_cipher("NY6")
{:ok, 5}

iex> decode_singular_cipher("")
:error

iex> decode_singular_cipher("RZJRXKW936")
:error

decode_singular_cipher!(cipher()) :: key()

Handles parsing the response and raising an error in the event of failure

## Examples

iex> decode_singular_cipher!("NY6")
5

iex> decode_singular_cipher!("")
** (ArgumentError) ShortIds: invalid cipher: ""

encode(key() | keys(), options()) :: cipher()

Encodes a given cipher to a unique short-id

## Examples

iex> encode(5)
"NY6"

iex> encode([5, 38, 12345])
"RZJRXKW936"