validate

Documentation

Index

• func Description(input, fieldName string) error
• func Email(input string) error
• func InviteCode(input string) error
• func Name(input string) error
• func NewValidationError(msg string) error
• func Password(input string) error
• func VerificationCode(input string) error
• type Func
  • func ConfirmPassword(previous string) Func
  • func Confirmer(defaultYes bool) Func
  • func OneOf(choices []string) Func
  • func SlugValidator(fieldName string) Func
• type ValidationError
  • func (e *ValidationError) Error() string

Functions

func Description

func Description(input, fieldName string) error

Description validates whether the input meets the descriptin requirements

func Email

func Email(input string) error

Email validates whether the input is a valid email format

func InviteCode

func InviteCode(input string) error

InviteCode validates whether the input meets the invite code requirements

func Name

func Name(input string) error

Name validates whether the input meets first name last name requirements

func NewValidationError

func NewValidationError(msg string) error

NewValidationError returns a validation error

func Password

func Password(input string) error

Password ensures the input meets password requirements

func VerificationCode

func VerificationCode(input string) error

VerificationCode validates whether the input meets the verification code requirements

Types

type Func

type Func promptui.ValidateFunc

Func represents a validation function

var OrgName Func

OrgName validates whether the input meets the org name requirements

var PolicyName Func

PolicyName validates whether the input meets the policy name requirements

var ProjectName Func

ProjectName validates whether the input meets the project name requirements

var RoleName Func

RoleName validates whether the input meets the role name requirements

var TeamName Func

TeamName validates whether the input meets the team name requirements

var Username Func

Username validates whether the input meets the username requirements

func ConfirmPassword

func ConfirmPassword(previous string) Func

ConfirmPassword ensures the input meets the password requirements and matches the previously provided password

func Confirmer

func Confirmer(defaultYes bool) Func

Confirmer returns a confirmation validation function which validates the input depending on whether or not this prompt is default Yes or No.

func OneOf

func OneOf(choices []string) Func

OneOf returns a validation function which validates whether or not the input matches one of the given options.

func SlugValidator

func SlugValidator(fieldName string) Func

SlugValidator returns a validation function

type ValidationError

type ValidationError struct {
	// contains filtered or unexported fields
}

ValidationError represents an error encountered when validating a field

func (*ValidationError) Error

func (e *ValidationError) Error() string

Error returns the error message completing the Error interface