errors

README

Errors

A simple utility for error handling in go/echo microservices

Documentation

Index

• Variables
• func Handler(err error, c echo.Context)
• type Code
  • func (e Code) Error() string
• type HTTPError
• type Response
  • func (e Response) Error() string
  • func (e Response) GetResponse() interface{}
  • func (e Response) GetStatusCode() int

Variables

var New = errors.New

New is a drop in replacement for standar errors package

Functions

func Handler

func Handler(err error, c echo.Context)

Handler serializes an error

Types

type Code

type Code string

Code is to make it easier to return a 400

func (Code) Error

func (e Code) Error() string

type HTTPError

type HTTPError interface {
	GetStatusCode() int
	GetResponse() interface{}
}

HTTPError is an interface for structured errors

type Response

type Response struct {
	StatusCode int    `json:"-"`
	Code       string `json:"code,omitempty"`
	Detail     string `json:"detail,omitempty"`
}

Response is the default structure of an error response

func (Response) Error

func (e Response) Error() string

func (Response) GetResponse

func (e Response) GetResponse() interface{}

GetResponse returns the same object

func (Response) GetStatusCode

func (e Response) GetStatusCode() int

GetStatusCode returns the status code