response

Documentation

Index

• type IError
• type Pagination
• type Response
  • func Error(err IError) Response[*int, *int]
  • func ErrorExplicit[E any](code string, message string, data E) Response[*int, E]
  • func ErrorWithData[E any](err IError, data E) Response[*int, E]
  • func Success() Response[*int, *int]
  • func SuccessWithData[T any](data T, pagination ...Pagination) Response[T, *int]
• type ResponseError

Types

type IError

type IError interface {
	error
	Code() string
}

type Pagination

type Pagination struct {
	Cursor interface{} `json:"cursor,omitempty"`
	Total  *int64      `json:"total,omitempty"`
}

Pagination contains data related to pagination for a request

type Response

type Response[T any, E any] struct {
	Error      *ResponseError[E] `json:"error,omitempty"`
	Data       T                 `json:"data,omitempty"`
	Pagination *Pagination       `json:"pagination,omitempty"`
}

func Error

func Error(err IError) Response[*int, *int]

func ErrorExplicit

func ErrorExplicit[E any](code string, message string, data E) Response[*int, E]

func ErrorWithData

func ErrorWithData[E any](err IError, data E) Response[*int, E]

func Success

func Success() Response[*int, *int]

func SuccessWithData

func SuccessWithData[T any](data T, pagination ...Pagination) Response[T, *int]

type ResponseError

type ResponseError[E any] struct {
	Code    string `json:"code"`
	Message string `json:"message"`
	Data    E      `json:"data,omitempty"`
}