Namespace validation

Index

Classes

Validation

Type aliases

Functions

Type aliases

ValidationFunction

ValidationFunction: (value: ValidationInput) => boolean | string

Type declaration

- (value: ValidationInput): boolean | string
- Parameters
  - value: ValidationInput
  Returns boolean | string

ValidationInput

ValidationInput: string | number | null | undefined

ValidationOutput

ValidationOutput: string | boolean

Functions

Const between

between(value: ValidationInput, min: number, max: number): ValidationOutput

- Defined in src/validation.ts:81
A between rule for ValidationInput

Parameters
- value: ValidationInput
  
  ValidationInput
- min: number
  
  Minimum value, inclusive
- max: number
  
  Maximum value, inclusive
Returns ValidationOutput
True if it validates or else validation message

Const initValidation

initValidation(): Validation

- Defined in src/validation.ts:135
Initiates a new Validation object upon call

Returns Validation
Validation object ready to be set

Const maximum

maximum(value: ValidationInput, max: number): ValidationOutput

- Defined in src/validation.ts:119
A maximum rule for ValidationInput

Parameters
- value: ValidationInput
  
  ValidationInput
- max: number
  
  Minimum value, inclusive
Returns ValidationOutput
True if it validates or else validation message

Const minimum

minimum(value: ValidationInput, min: number): ValidationOutput

- Defined in src/validation.ts:101
A minimum rule for ValidationInput

Parameters
- value: ValidationInput
  
  ValidationInput
- min: number
  
  Minimum value, inclusive
Returns ValidationOutput
True if it validates or else validation message

Const number

number(value: ValidationInput, validationMessage?: string): ValidationOutput

- Defined in src/validation.ts:61
A number rule for ValidationInput

Parameters
- value: ValidationInput
  
  ValidationInput
- validationMessage: string = VALIDATION_MESSAGES.NUMBER
  
  Validation message to return if the validation fails
Returns ValidationOutput
True if it validates or else the validation message given

Const required

required(value: ValidationInput, validationMessage?: string): ValidationOutput

- Defined in src/validation.ts:39
A required rule for ValidationInput

Parameters
- value: ValidationInput
  
  ValidationInput
- validationMessage: string = VALIDATION_MESSAGES.REQUIRED
  
  Validation message to return if the validation fails
Returns ValidationOutput
True if it validates or else the validation message given

Const validate

validate(value: ValidationInput, validationFunctions: ValidationFunction[]): ValidationOutput

- Defined in src/validation.ts:17
Validate a value

Parameters
- value: ValidationInput
  
  Value to validate
- validationFunctions: ValidationFunction[]
  
  Validation functions to run through
Returns ValidationOutput
True if it validates or else a validation message

Generated using TypeDoc