fxrf

Documentation

Index

• Variables
• type Config
• type ErrorResp
• type Factory
  • func NewFactory(l *zap.Logger, cfg *Config, version fxecumenos.Version) Factory
• type FailureResp
• type Metadata
• type ResponseBuildOption
  • func WithCause(err error) ResponseBuildOption
  • func WithData(data interface{}) ResponseBuildOption
  • func WithHTTPStatusCode(code int) ResponseBuildOption
  • func WithLogger(l *zap.Logger) ResponseBuildOption
  • func WithMessage(msg string) ResponseBuildOption
• type Status
• type SuccessResp
• type Writer
  • func NewWriter(l *zap.Logger, rw http.ResponseWriter, appVersion fxecumenos.Version, ...) Writer

Variables

var Module = fx.Options(
	fx.Provide(NewFactory),
)

Types

type Config

type Config struct {
	WriteLogs bool
}

type ErrorResp

type ErrorResp struct {
	Status   Status    `json:"status"`
	Message  string    `json:"message"`
	Metadata *Metadata `json:"metadata"`
}

type Factory

type Factory interface {
	NewWriter(rw http.ResponseWriter) Writer
}

func NewFactory

func NewFactory(l *zap.Logger, cfg *Config, version fxecumenos.Version) Factory

type FailureResp

type FailureResp[T interface{}] struct {
	Status   Status    `json:"status"`
	Data     T         `json:"data"`
	Message  string    `json:"message"`
	Metadata *Metadata `json:"metadata"`
}

type Metadata

type Metadata struct {
	RequestID string `json:"requestId"`
	Duration  int    `json:"duration"`
	Timestamp string `json:"timestamp"`
	Version   string `json:"version"`
}

type ResponseBuildOption

type ResponseBuildOption func(b *responseBuilder)

func WithCause

func WithCause(err error) ResponseBuildOption

func WithData

func WithData(data interface{}) ResponseBuildOption

func WithHTTPStatusCode

func WithHTTPStatusCode(code int) ResponseBuildOption

func WithLogger

func WithLogger(l *zap.Logger) ResponseBuildOption

func WithMessage

func WithMessage(msg string) ResponseBuildOption

type Status

type Status string

const (
	SuccessStatus Status = "success"
	FailureStatus Status = "failure"
	ErrorStatus   Status = "error"
)

type SuccessResp

type SuccessResp[T interface{}] struct {
	Status   Status    `json:"status"`
	Data     T         `json:"data"`
	Metadata *Metadata `json:"metadata"`
}

type Writer

type Writer interface {
	SetLogger(logger *zap.Logger)
	WriteSuccess(ctx context.Context, payload interface{}, opts ...ResponseBuildOption) error
	WriteFail(ctx context.Context, data interface{}, opts ...ResponseBuildOption) error
	WriteError(ctx context.Context, msg string, cause error, opts ...ResponseBuildOption) error
}

func NewWriter

func NewWriter(l *zap.Logger, rw http.ResponseWriter, appVersion fxecumenos.Version, writeLogs bool) Writer