validation

Documentation

Index

• Variables
• func IsValid[T any](obj T) bool
• func SanitizeString(str string) string
• type Error
  • func ParseStructValidationErrors(validationErrors validator.ValidationErrors) *Error
  • func (e *Error) Error() string

Variables

var ErrInvalid = errors.New("object is invalid")

var ErrNilObject = errors.New("object is nil")

var Validate = validator.New(validator.WithRequiredStructEnabled())

Functions

func IsValid

func IsValid[T any](obj T) bool

IsValid will check if an object is valid according to the validation tags on the object. It does not return any details of validation issues, only a boolean for valid (true) or invalid (false).

func SanitizeString

func SanitizeString(str string) string

SanitizeString attempts to "sanitize" a string value. It will strip any leading/trailing whitespace and then run the string through bluemonday to remove dangerous components. This should retain HTML5 content.

Types

type Error

type Error struct {
	Details string
	// contains filtered or unexported fields
}

Error is a map of fields and their validation errors.

func ParseStructValidationErrors

func ParseStructValidationErrors(validationErrors validator.ValidationErrors) *Error

ParseStructValidationErrors takes the underlying validation errors and formats them so that each struct field has an array of all validation errors associated with it.

func (*Error) Error

func (e *Error) Error() string