app

Documentation

Index

• Constants
• func AuthError() error
• func NotFoundError() error
• func ParamError(err error) error
• func WithCode(err error, code int) error
• type App
  • func (a *App) Run()
• type CodedError
  • func (e *CodedError) Error() string

Constants

const (
	CodeInternalError = 1000
	CodeBadParam      = 1001
	CodeNotFound      = 1002
	CodeUnauthorized  = 1003
)

Code enums.

Functions

func AuthError

func AuthError() error

AuthError generates auth error.

func NotFoundError

func NotFoundError() error

NotFoundError indicates resource not found.

func ParamError

func ParamError(err error) error

ParamError generates BadParamError.

func WithCode

func WithCode(err error, code int) error

WithCode adds code to error.

Types

type App

type App struct {
	Flags  []cli.Flag
	Before func(*cli.Context) error
	After  func(*cli.Context) error
	Action func(context.Context)
}

App is cli wrapper that do some common operation and creates signal handler.

func (*App) Run

func (a *App) Run()

Run setups everything and runs Main.

type CodedError

type CodedError struct {
	Err        error
	AppCode    int
	StatusCode int
}

CodedError implements app code helper. it shouldn't be used directly.

func (*CodedError) Error

func (e *CodedError) Error() string

Error returns internal error or by status code.