validol

validol

Validation library for golang.

Content

• Install
• Usage
• Validators
• Combinators

Install

go get -u github.com/cospectrum/validol

Requires Go version 1.22.0 or greater.

Usage

import (
	"errors"
	vd "github.com/cospectrum/validol"
)

type Sex string

func (s Sex) Validate() error {
	return vd.OneOf[Sex]("male", "female", "other")(s)
}

type Email string

func (e Email) Validate() error {
	return vd.All(
		vd.Len[string](vd.Gt(5)),
		vd.Len[string](vd.Lte(100)),
		vd.Email,
	)(string(e))
}

type User struct {
	Email Email
	Sex   Sex
	age   int
}

func (u User) Validate() error {
	return errors.Join(
		vd.Gte(18)(u.age),
		vd.Walk(u), // to continue the `Walk` using the descendants' `Validate` methods
	)
}

func main() {
	users := []User{
		{Email: "[email protected]", age: 22},
		{Email: "[email protected]", Sex: "male"},
	}
	if err := vd.Validate(users); err != nil {
		panic(err)
	}
}

Validators

Type Validator[T] is equivalent to func(T) error.
Validatable interface requires Validate() error method.

Combinators

Functions that create a Validator[T].