id

Documentation

Index

• Variables
• func MustNew(opts ...Option) string
• func New(opts ...Option) (string, error)
• func ToUUID(s string) uuid.UUID
• type Generator
  • func (g *Generator) MustNew() string
  • func (g *Generator) New() (string, error)
• type Option
  • func WithNanoidAlphabet(alphabet string) Option
  • func WithNanoidSize(size int) Option
  • func WithUUIDNode(node [6]byte) Option
• type Options
  • func NewOptions(opts ...Option) Options
• type Type

Variables

var DefaultNanoidAlphabet = "6789BCDFGHJKLMNPQRTWbcdfghjkmnpqrtwz"

DefaultNanoidAlphabet is the alphabet used for ID characters by default

var DefaultNanoidSize = 16

DefaultNanoidSize is the size used for ID by default To get uuid like collision specify 21

Functions

func MustNew

func MustNew(opts ...Option) string

Must is the same as New but fatals on error

func New

func New(opts ...Option) (string, error)

New returns new id or error

func ToUUID

func ToUUID(s string) uuid.UUID

Types

type Generator

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

func (*Generator) MustNew

func (g *Generator) MustNew() string

func (*Generator) New

func (g *Generator) New() (string, error)

type Option

type Option func(*Options)

Option func signature

func WithNanoidAlphabet

func WithNanoidAlphabet(alphabet string) Option

WithNanoidAlphabet specifies alphabet to use

func WithNanoidSize

func WithNanoidSize(size int) Option

WithNanoidSize specifies generated id size

func WithUUIDNode

func WithUUIDNode(node [6]byte) Option

WithUUIDNode specifies node component for UUIDv8

type Options

type Options struct {
	Type           Type
	NanoidAlphabet string
	NanoidSize     int
	UUIDNode       [6]byte
}

Options contains id deneration options

func NewOptions

func NewOptions(opts ...Option) Options

NewOptions returns new Options struct filled by opts

type Type

type Type int

const (
	TypeUnspecified Type = iota
	TypeNanoid
	TypeUUIDv8
)