jetify-com/typeid-goPublic

NotificationsYou must be signed in to change notification settings
Fork10
Star176

Go implementation of TypeIDs: type-safe, K-sortable, and globally unique identifiers inspired by Stripe IDs

License

Apache-2.0 license

176 stars 10 forks Branches Tags Activity

Star

Notifications

You must be signed in to change notification settings

Branches Tags

Folders and files

Name		Name	Last commit message	Last commit date
Latest commit History 59 Commits
.github		.github
base32		base32
testdata		testdata
.gitignore		.gitignore
CODE_OF_CONDUCT.md		CODE_OF_CONDUCT.md
CONTRIBUTING.md		CONTRIBUTING.md
LICENSE		LICENSE
README.md		README.md
bench_test.go		bench_test.go
constructors.go		constructors.go
doc.go		doc.go
encoding.go		encoding.go
encoding_test.go		encoding_test.go
errors.go		errors.go
errors_test.go		errors_test.go
examples_test.go		examples_test.go
go.mod		go.mod
go.sum		go.sum
shared_test.go		shared_test.go
sql.go		sql.go
sql_test.go		sql_test.go
typeid.go		typeid.go
typeid_test.go		typeid_test.go
validate.go		validate.go

Repository files navigation

TypeID Go

A golang implementation ofTypeIDs

TypeIDs are a modern,type-safe, globally unique identifier based on the upcomingUUIDv7 standard. They provide a ton of nice properties that make them a great choiceas the primary identifiers for your data in a database, APIs, and distributed systems.Read more about TypeIDs in theirspec.

This particular implementation provides a go library for generating and parsing TypeIDs.

Installation

To add this library as a dependency in your go module, run:

go get go.jetify.com/typeid/v2

Usage

This library provides a go implementation of TypeID:

import ("go.jetify.com/typeid/v2")funcexample() {// Generate a new TypeID with a prefix (panics on invalid prefix)tid:=typeid.MustGenerate("user")fmt.Println(tid)// Generate a new TypeID without a prefixtid=typeid.MustGenerate("")fmt.Println(tid)// Generate with error handlingtid,err:=typeid.Generate("user")iferr!=nil {log.Fatal(err)  }// Parse an existing TypeIDtid,_=typeid.Parse("user_00041061050r3gg28a1c60t3gf")fmt.Println(tid)// Convert from UUIDtid,_=typeid.FromUUID("user","018e5f71-6f04-7c5c-8123-456789abcdef")fmt.Println(tid)}