hxid

README

Globally Unique ID Generator

Thin wrapper around github.com/oklog/ulid/v2 that renders the 16-byte ULID as base58 instead of the native Crockford base32. ULIDs are lexicographically time-sortable, so New() and NewTimeSort() are aliases retained for call-site compatibility.

Documentation

Overview

Package hxid produces sortable, base58-encoded unique IDs backed by ULIDs.

Index

• type ID
  • func New() ID
  • func NewTimeSort() ID
  • func (id ID) String() string

Types

type ID

type ID struct {
	// contains filtered or unexported fields
}

ID is a 16-byte ULID rendered as base58 via String().

func New

func New() ID

New returns a freshly generated, time-sortable ID.

func NewTimeSort

func NewTimeSort() ID

NewTimeSort is retained for call-site compatibility with the previous hxid API. Every ULID is already lexicographically time-sortable, so it is an alias for New.

func (ID) String

func (id ID) String() string

String returns the base58 encoding of the underlying 16-byte ULID.