validator

Documentation

Index

• Variables
• type ErrUnsupportedValidationTag
  • func (e ErrUnsupportedValidationTag) Error() string
• type Error
  • func (e Error) Error() string
• type Option
  • func ErrorFieldFromJSONTag() Option
• type Result
  • func (r Result) Invalid() bool
• type Validator
  • func New(options ...Option) Validator
  • func (v Validator) Validate(payload interface{}) (Result, error)

Variables

var ErrNonStructPayload = errors.New("validation payload is not a struct")

Types

type ErrUnsupportedValidationTag

type ErrUnsupportedValidationTag struct {
	Tag string
}

func (ErrUnsupportedValidationTag) Error

func (e ErrUnsupportedValidationTag) Error() string

type Error

type Error struct {
	Type    string                 `json:"type"`
	Field   string                 `json:"field"`
	Value   interface{}            `json:"value,omitempty"`
	Details map[string]interface{} `json:"details,omitempty"`
}

func (Error) Error

func (e Error) Error() string

type Option

type Option func(*Validator)

func ErrorFieldFromJSONTag

func ErrorFieldFromJSONTag() Option

type Result

type Result struct {
	Errors []Error `json:"validation_errors"`
}

func (Result) Invalid

func (r Result) Invalid() bool

type Validator

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

func New

func New(options ...Option) Validator

func (Validator) Validate

func (v Validator) Validate(payload interface{}) (Result, error)