shortid

Documentation

Index

• type KSUID
  • func New(_ ...Setting) *KSUID
  • func (s KSUID) Gen() string
  • func (s KSUID) Name() string
  • func (s KSUID) Size() int
  • func (s KSUID) Validate(id string) bool
• type Setting

Types

type KSUID

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

func New

func New(_ ...Setting) *KSUID

New creates a new KSUID generator with a unique node.

func (KSUID) Gen

func (s KSUID) Gen() string

Gen generates a new KSUID ID as a string.

func (KSUID) Name

func (s KSUID) Name() string

Name returns the name of the generator.

func (KSUID) Size

func (s KSUID) Size() int

Size returns the bit size of the generated KSUID ID.

func (KSUID) Validate

func (s KSUID) Validate(id string) bool

Validate checks if the provided ID is a valid KSUID ID.

type Setting

type Setting struct {
}