core_dtos

Documentation

Index

• Constants
• type ErrorItem
• type Option
  • func WithContext(ctx fiber.Ctx) Option
  • func WithOldContext(ctx *fiberold.Ctx) Option
• type ResponseDto
  • func NewResp(opts ...Option) *ResponseDto
  • func NewResponse(ctx fiber.Ctx) *ResponseDto
  • func (r *ResponseDto) File() error
  • func (r *ResponseDto) JSON() error
  • func (r *ResponseDto) SetData(data interface{})
  • func (r *ResponseDto) SetError(key int, msg string) *ResponseDto
  • func (r *ResponseDto) SetFile(name string, data []byte)
  • func (r *ResponseDto) SetHeaders(headers map[string]string)
  • func (r *ResponseDto) SetMessage(text string)
  • func (r *ResponseDto) SetStatus(status int)
• type ResponseOptions

Constants

const (
	OkStatus   = "ok"
	FailStatus = "fail"
)

Types

type ErrorItem

type ErrorItem struct {
	Key     int    `json:"key"`
	Message string `json:"message"`
}

ErrorItem contains error's key and message

type Option

type Option func(o *ResponseOptions)

func WithContext

func WithContext(ctx fiber.Ctx) Option

func WithOldContext

func WithOldContext(ctx *fiberold.Ctx) Option

type ResponseDto

type ResponseDto struct {
	ResponseOptions

	Status  string        `json:"status"`
	Message string        `json:"message"`
	Errors  []ErrorItem   `json:"errors"`
	Data    []interface{} `json:"data"`

	TmRequest   string    `json:"tm_req"`
	TmRequestSt time.Time `json:"-"`
	// contains filtered or unexported fields
}

ResponseDto generic response DTO

func NewResp

func NewResp(opts ...Option) *ResponseDto

NewResp wrap context (compatible both for v2 and v3)

func NewResponse

func NewResponse(ctx fiber.Ctx) *ResponseDto

NewResponse wrap context (compatible only with fiber v3)

func (*ResponseDto) File

func (r *ResponseDto) File() error

File finalize response and convert to file

func (*ResponseDto) JSON

func (r *ResponseDto) JSON() error

JSON finalize response and convert to Json

func (*ResponseDto) SetData

func (r *ResponseDto) SetData(data interface{})

SetData response data

func (*ResponseDto) SetError

func (r *ResponseDto) SetError(key int, msg string) *ResponseDto

SetError set key/msg error

func (*ResponseDto) SetFile

func (r *ResponseDto) SetFile(name string, data []byte)

SetFile name and data

func (*ResponseDto) SetHeaders

func (r *ResponseDto) SetHeaders(headers map[string]string)

SetHeaders response headers

func (*ResponseDto) SetMessage

func (r *ResponseDto) SetMessage(text string)

SetMessage response message

func (*ResponseDto) SetStatus

func (r *ResponseDto) SetStatus(status int)

SetStatus response status

type ResponseOptions

type ResponseOptions struct {
	// contains filtered or unexported fields
}