validation

Documentation

Index

• Constants
• func SubField(field string, child string) string
• type Result
  • func NewResult(code, err string) *Result
  • func (r *Result) AddFieldError(field string, err string)
  • func (r Result) IsValid() bool
• type Validator

Constants

const (
	FieldType     = "type"
	FieldChannels = "channels"
	FieldToken    = "token"
)

Functions

func SubField

func SubField(field string, child string) string

SubField creates a field that includes parent and child that separated by a default separator.

Types

type Result

type Result struct {
	Error       string       `json:"error,omitempty"`
	Code        string       `json:"code,omitempty"`
	FieldErrors []fieldError `json:"field_errors,omitempty"`
}

Result represent validation result that include error message, error code, and field validation errors.

func NewResult

func NewResult(code, err string) *Result

NewResult creates a new Result object with the input code and error.

func (*Result) AddFieldError

func (r *Result) AddFieldError(field string, err string)

AddFieldError creates a new fieldError object and adds it to the Result.FieldErrors

func (Result) IsValid

func (r Result) IsValid() bool

IsValid returns false if there is error, code, or field errors does exist. Otherwise, returns true.

type Validator

type Validator interface {
	Validate() *Result
}