api

Documentation

Index

• Constants
• type Error
  • func CommitError(err error, errorCode ErrorCode, userMessage string) *Error
  • func WrapError(err *Error, msg string) *Error
  • func (e Error) Cause() error
  • func (e Error) Error() string
• type ErrorCode

Constants

const DefaultErrorCode = ErrorCode("unknown_error")

Types

type Error

type Error struct {
	ErrorCode     ErrorCode
	UserMessage   string
	InternalError error
}

supposedly, having a public error type in Go is an antipattern however, all usecase methods will return this expected structure and the gateways will all require this metadata to return a proper error so I believe it's worth trying a concrete error type instead of a bunch of package methods that guess at your error's insides

func CommitError

func CommitError(err error, errorCode ErrorCode, userMessage string) *Error

func WrapError

func WrapError(err *Error, msg string) *Error

func (Error) Cause

func (e Error) Cause() error

func (Error) Error

func (e Error) Error() string

type ErrorCode

type ErrorCode string