qsval

Documentation

Index

• Variables
• func ProvideEnglishTranslator() fx.Option
• func ProvideValidator() fx.Option
• func RegisterTranslations(trans map[string]string) fx.Option
• func RegisterValidations(vals map[string]validator.Func) fx.Option
• func Translate(err error, trs ut.Translator) ([]string, error)

Variables

var (
	ErrValidationsNil     = errors.New("provided validation is nil")
	ErrTransNil           = errors.New("provided translation is nil")
	ErrValidatorNotFound  = errors.New("validator not found")
	ErrTranslatorNotFound = errors.New("translator not found")
)

Functions

func ProvideEnglishTranslator

func ProvideEnglishTranslator() fx.Option

Provide an instance of English validation translator

 var Module = fx.Options(
		qsval.ProvideEnglishTranslator(),
 )

func ProvideValidator

func ProvideValidator() fx.Option

Provide an instance of validator.

 var Module = fx.Options(
		qsval.ProvideValidator(),
 )

func RegisterTranslations

func RegisterTranslations(trans map[string]string) fx.Option

Register a set of translations.

 var Module = fx.Options(
		qsval.RegisterTranslations(map[string]validator.Func{
			"clientname": "{0} must be alphanumeric"
		})
 )

func RegisterValidations

func RegisterValidations(vals map[string]validator.Func) fx.Option

Register a set of validations.

 var Module = fx.Options(
		qsval.RegisterValidations(map[string]validator.Func{
			"clientname": func(fl validator.FieldLevel) bool {
				// Validate
				return true
			}
     	})
 )

func Translate

func Translate(err error, trs ut.Translator) ([]string, error)

Perform translating all validation errors into readable strings. Must provide a ut.Translator

var dto SomeDto
errs := validator.Struct(&dto)
var trans []string
trans, err := qsval.Translate(errs, trs)
if err != nil {
	// Return some error
}