idkit

Documentation

Overview

Package idkit provides the set of functions to generate different kind of identifiers.

Index

• func DigiCode() string
• func ULID() string
• func ValidateDigiCode(code string) error
• func ValidateULID(id string) error
• func ValidateXID(id string) error
• func XID() string
• type Error
  • func (e Error) Error() string

Functions

func DigiCode

func DigiCode() string

DigiCode returns 6-digit code as a string.

func ULID

func ULID() string

ULID returns ULID identifier as string. More about ULID: https://github.com/ulid/spec

func ValidateDigiCode

func ValidateDigiCode(code string) error

ValidateDigiCode validates code from DigiCode.

func ValidateULID

func ValidateULID(id string) error

ValidateULID validates string representation of ULID identifier.

func ValidateXID

func ValidateXID(id string) error

ValidateXID validates string representation of XID identifier.

func XID

func XID() string

XID returns short unique identifier as string.

Types

type Error

type Error string

Error represents package level error.

const (
	// ErrInvalidID represents an error which indicates that given TID is invalid.
	ErrInvalidID Error = "id: invalid identifier"
)

func (Error) Error

func (e Error) Error() string