Categorygithub.com/go-playground/validator
modulepackage
3.0.2+incompatible
Repository: https://github.com/go-playground/validator.git
Documentation: pkg.go.dev
Overview
Versions
7
Dependencies
9
Dependents
914
Files
1.1k SLOC

# README

Package go-validate-yourself

Build Status

Package validator implements value validations for structs and individual fields based on tags.

Installation

Just use go get.

go get gopkg.in/joeybloggs/go-validate-yourself.v3

or to update

go get -u gopkg.in/joeybloggs/go-validate-yourself.v3

And then just import the package into your own code.

import "gopkg.in/joeybloggs/go-validate-yourself.v3"

Usage

Please see http://godoc.org/gopkg.in/joeybloggs/go-validate-yourself.v3 for detailed usage docs.

Contributing

There will be a development branch for each version of this package i.e. v1-development, please make your pull requests against those branches.

If changes are breaking please create an issue, for discussion and create a pull request against the highest development branch for example this package has a v1 and v1-development branch however, there will also be a v2-development brach even though v2 doesn't exist yet.

I strongly encourage everyone whom creates a custom validation function to contribute them and help make this package even better.

# Functions

NewValidator creates a new Validator instance NOTE: it is not necessary to create a new validator as the internal one will do in 99.9% of cases, but the option is there.

# Variables

BakedInValidators is the map of ValidationFunc used internally but can be used with any new Validator if desired.

# Structs

FieldValidationError contains a single fields validation error.
StructValidationErrors is hierarchical list of field and struct errors.
Validator implements the Validator Struct NOTE: Fields within are not thread safe and that is on purpose Functions Tags etc.

# Type aliases

ValidationFunc that accepts a value(optional usage), a field and parameter(optional usage) for use in validation.