id

Documentation

Index

• type GenerateRequest
• type GenerateResponse
• type IdService
  • func NewIdService(token string) *IdService
  • func (t *IdService) Generate(request *GenerateRequest) (*GenerateResponse, error)
  • func (t *IdService) Types(request *TypesRequest) (*TypesResponse, error)
• type TypesRequest
• type TypesResponse

Types

type GenerateRequest

type GenerateRequest struct {
	// type of id e.g uuid, shortid, snowflake (64 bit), bigflake (128 bit)
	Type string `json:"type"`
}

type GenerateResponse

type GenerateResponse struct {
	// the unique id generated
	Id string `json:"id"`
	// the type of id generated
	Type string `json:"type"`
}

type IdService

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

func NewIdService

func NewIdService(token string) *IdService

func (*IdService) Generate

func (t *IdService) Generate(request *GenerateRequest) (*GenerateResponse, error)

Generate a unique ID. Defaults to uuid.

func (*IdService) Types

func (t *IdService) Types(request *TypesRequest) (*TypesResponse, error)

List the types of IDs available. No query params needed.

type TypesRequest

type TypesRequest struct {
}

type TypesResponse

type TypesResponse struct {
	Types []string `json:"types"`
}