Skip to content

giacomocavalieri/sqid

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

2 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

🦑 sqid

Package Version Hex Docs

Sqids (pronounced "squids") are short unique identifiers generated from numbers. These IDs are URL-safe, can encode several numbers, and can be made to not contain profanity words.

The main use of Sqids is purely visual. This is not an encryption library, and Sqids should not carry secrets: anyone who can guess the encoding alphabet will have access to the numbers that generated a Sqid. You can read more about sqid's use cases on their website!

This is how you create a squid:

gleam add sqid@1
import sqid

pub fn main() -> Nil {
  // Start by defining what alphabet you want to use to generate sqids
  let assert Ok(alphabet) = sqid.alphabet("abcdefghijklmnopqrstuvwxyz")
  // You can also set a minimum length for generated Sqids
  let sqid = sqid.new(alphabet) |> sqid.set_minimum_length(8)
  // Turn any sequence of numbers into a Sqid!
  assert Ok("voqcetma") == sqid.encode(sqid, [11])
}

About

🦑 short, unique identifiers generated from numbers

Resources

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages