Categorygithub.com/h-golang/validator
modulepackage
4.0.4+incompatible
Repository: https://github.com/h-golang/validator.git
Documentation: pkg.go.dev
Overview
Versions
6
Dependencies
10
Dependents
0
Files
996 SLOC

# README

Package go-validate-yourself

Build Status GoDoc

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

Installation

Just use go get.

go get gopkg.in/bluesuncorp/go-validate-yourself.v4

or to update

go get -u gopkg.in/bluesuncorp/go-validate-yourself.v4

And then just import the package into your own code.

import "gopkg.in/bluesuncorp/go-validate-yourself.v4"

Usage

Please see http://godoc.org/gopkg.in/bluesuncorp/go-validate-yourself.v4 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.

License

Distributed under MIT License, please see license file in code for more details.

# Functions

NewValidator creates a new Validator instance for use.

# Variables

BakedInValidators is the default map of ValidationFunc you can add, remove or even replace items to suite your needs, or even disregard and use your own map if so desired.

# Structs

FieldValidationError contains a single field's validation error along with other properties that may be needed for error message creation.
StructValidationErrors is hierarchical list of field and struct validation errors for a non hierarchical representation please see the Flatten method for StructValidationErrors.
Validator implements the Validator Struct NOTE: Fields within are not thread safe and that is on purpose Functions and Tags should all be predifined before use, so subscribe to the philosiphy or make it thread safe on your end.

# Type aliases

ValidationFunc accepts all values needed for file and cross field validation top = top level struct when validating by struct otherwise nil current = current level struct when validating by struct otherwise optional comparison value f = field value for validation param = parameter used in validation i.e.