Packages

typeid_elixir

0.0.1
1.1.0 1.0.0 0.6.0 0.5.3 0.5.2 0.5.1 0.5.0 0.4.0 0.3.1 0.3.0 0.2.2 0.2.1 0.2.0 0.1.0 0.0.1

A type-safe, K-sortable, globally unique identifier inspired by Stripe IDs

HexDocs

Current section

Files

Jump to
Readme
15 Versions
1 Dependency
Dependants
Files
Activity
typeid_elixir README.md
Raw

README.md 

# TypeID Elixir



[![CI](https://github.com/sloanelybutsurely/typeid-elixir/actions/workflows/ci.yaml/badge.svg)](https://github.com/sloanelybutsurely/typeid-elixir/actions/workflows/ci.yaml)



### A type-safe, K-sortable, globally unique identifier inspired by Stripe IDs



[TypeIDs](https://github.com/jetpack-io/typeid) are a modern, type-safe, globally unique identifier based on the upcoming UUIDv7 standard. They provide a ton of nice properties that make them a great choice as the primary identifiers for your data in a database, APIs, and distributed systems. Read more about TypeIDs in their spec.



## Installation



The package can be installed by adding `typeid` to your list of dependencies in

`mix.exs`:



```elixir

def deps do

  [

    {:typeid, "~> 0.0.1"}

  ]

end

```



## Spec



The original TypeID spec is defined [here](https://github.com/jetpack-io/typeid).