cookbook

README

Cookbook

Utilities library for Go(Golang) development

Documentation

Index

• Constants
• func BoolEnv(key string) (bool, error)
• func IntEnv(key string) (int, error)
• func ParsePtrString(s *string) string
• func ParseStringNil(s string) *string
• func ParseStringToFloat64(str string, def float64) float64
• func ParseStringToInt(str string, def int) int
• func ParseStringToPhone(phone, defaultRegionCode string, phoneFormat phonenumbers.PhoneNumberFormat) (string, error)
• func StringEnv(key string) (string, error)
• func Stringify(str interface{}) string
• type JSON
• type JSend
  • func ErrorResponse(msg string, code interface{}) JSend
  • func FailResponse(data *JSON, code interface{}) JSend
  • func SuccessDataResponse(data interface{}, meta *Meta) JSend
  • func SuccessResponse() JSend
  • func (j JSend) Stringify() string
• type Links
  • func NewLinks(next, prev string) *Links
• type Meta
  • func NewMeta(links *Links) *Meta

Constants

const (
	// RequestID Incoming request id
	RequestID = "request_id"

	// Bearer
	Bearer = "Bearer"

	// XRequestID HTTP request header key X-Request-ID
	XRequestID = "X-Request-ID"
)

Functions

func BoolEnv

func BoolEnv(key string) (bool, error)

BoolEnv used for get bool value from environment

func IntEnv

func IntEnv(key string) (int, error)

IntEnv used for get bool value from environment

func ParsePtrString

func ParsePtrString(s *string) string

ParsePtrString function check pointer string, if nil return empty string

func ParseStringNil

func ParseStringNil(s string) *string

ParseStringNil function to check string if empty return nil

func ParseStringToFloat64

func ParseStringToFloat64(str string, def float64) float64

ParseStringToFloat64 Parse string to float64, error return default value

func ParseStringToInt

func ParseStringToInt(str string, def int) int

ParseStringToInt Parse string to int, error return default value

func ParseStringToPhone

func ParseStringToPhone(phone, defaultRegionCode string, phoneFormat phonenumbers.PhoneNumberFormat) (string, error)

ParseStringToPhone Function to parse string to formatted phone number See details documentation in https://github.com/nyaruka/phonenumbers defaultRegionCode using ISO 3166-Alpha 2

func StringEnv

func StringEnv(key string) (string, error)

StringEnv used for get string value from environment

func Stringify

func Stringify(str interface{}) string

Stringify Convert interface to string, error will return string error message

Types

type JSON

type JSON map[string]interface{}

type JSend

type JSend struct {
	Status  string      `json:"status"`
	Message string      `json:"message,omitempty"`
	Data    interface{} `json:"data,omitempty"`
	Meta    *Meta       `json:"meta,omitempty"`
	Code    interface{} `json:"code,omitempty"`
}

JSend used JSend format with some modification

func ErrorResponse

func ErrorResponse(msg string, code interface{}) JSend

ErrorResponse is used return response with JSON format if failure in server side

func FailResponse

func FailResponse(data *JSON, code interface{}) JSend

FailResponse is used to return response with JSON format if failure from client side

func SuccessDataResponse

func SuccessDataResponse(data interface{}, meta *Meta) JSend

SuccessDataResponse used to return response JSON format if have data value

func SuccessResponse

func SuccessResponse() JSend

SuccessResponse used to return response with JSON format success

func (JSend) Stringify

func (j JSend) Stringify() string

Stringify make JSend struct to string

type Links

type Links struct {
	Next string `json:"next,omitempty"`
	Prev string `json:"prev,omitempty"`
}

Links for meta data JSON response

func NewLinks

func NewLinks(next, prev string) *Links

NewLinks build new links struct

type Meta

type Meta struct {
	Links *Links `json:"links,omitempty"`
}

Meta data used for JSON response

func NewMeta

func NewMeta(links *Links) *Meta

NewMeta build new meta struct