String Module

Functions and values

Function or value Description

alpha field

Full Usage: alpha field

Parameters:
    field : string

Returns: Validator<string, string>

Validate alphabetic characters only

field : string
Returns: Validator<string, string>

alphanumeric field

Full Usage: alphanumeric field

Parameters:
    field : string

Returns: Validator<string, string>

Validate alphanumeric characters only

field : string
Returns: Validator<string, string>

contains substring field input

Full Usage: contains substring field input

Parameters:
    substring : string
    field : string
    input : string

Returns: ValidationResult<string>

Validate that string contains a value

substring : string
field : string
input : string
Returns: ValidationResult<string>

email field

Full Usage: email field

Parameters:
    field : string

Returns: Validator<string, string>

Validate email format

field : string
Returns: Validator<string, string>

endsWith suffix field input

Full Usage: endsWith suffix field input

Parameters:
    suffix : string
    field : string
    input : string

Returns: ValidationResult<string>

Validate that string ends with a suffix

suffix : string
field : string
input : string
Returns: ValidationResult<string>

exactLength length field input

Full Usage: exactLength length field input

Parameters:
    length : int
    field : string
    input : string

Returns: ValidationResult<string>

Validate exact length

length : int
field : string
input : string
Returns: ValidationResult<string>

lengthBetween min max field input

Full Usage: lengthBetween min max field input

Parameters:
    min : int
    max : int
    field : string
    input : string

Returns: ValidationResult<string>

Validate length range

min : int
max : int
field : string
input : string
Returns: ValidationResult<string>

matches pattern field message input

Full Usage: matches pattern field message input

Parameters:
    pattern : string
    field : string
    message : string
    input : string

Returns: ValidationResult<string>

Validate against a regex pattern

pattern : string
field : string
message : string
input : string
Returns: ValidationResult<string>

maxLength max field input

Full Usage: maxLength max field input

Parameters:
    max : int
    field : string
    input : string

Returns: ValidationResult<string>

Validate maximum length

max : int
field : string
input : string
Returns: ValidationResult<string>

minLength min field input

Full Usage: minLength min field input

Parameters:
    min : int
    field : string
    input : string

Returns: ValidationResult<string>

Validate minimum length

min : int
field : string
input : string
Returns: ValidationResult<string>

notEmpty field input

Full Usage: notEmpty field input

Parameters:
    field : string
    input : string

Returns: ValidationResult<string>

Validate that a string is not null or empty

field : string
input : string
Returns: ValidationResult<string>

numeric field

Full Usage: numeric field

Parameters:
    field : string

Returns: Validator<string, string>

Validate numeric characters only

field : string
Returns: Validator<string, string>

startsWith prefix field input

Full Usage: startsWith prefix field input

Parameters:
    prefix : string
    field : string
    input : string

Returns: ValidationResult<string>

Validate that string starts with a prefix

prefix : string
field : string
input : string
Returns: ValidationResult<string>

url field input

Full Usage: url field input

Parameters:
    field : string
    input : string

Returns: ValidationResult<string>

Validate URL format

field : string
input : string
Returns: ValidationResult<string>