@serenity-is/corelib / Validator

Class: Validator

Defined in: src/base/validator.tsx:259

Constructors

Constructor

new Validator(form, options): Validator

Defined in: src/base/validator.tsx:556

Parameters

form

HTMLFormElement

options

ValidatorOptions

Returns

Validator

Properties

dependTypes

dependTypes: object

Defined in: src/base/validator.tsx:1402

boolean()

boolean: (param) => any

Parameters

param

any

Returns

any

function()

function: (param, element) => any

Parameters

param

any

element

ValidatableElement

Returns

any

string()

string: (param, element) => boolean

Parameters

param

any

element

ValidatableElement

Returns

boolean

---

lastActive

lastActive: ValidatableElement

Defined in: src/base/validator.tsx:540

---

settings

readonly settings: ValidatorOptions

Defined in: src/base/validator.tsx:539

---

autoCreateRanges

static autoCreateRanges: boolean = false

Defined in: src/base/validator.tsx:267

---

classRuleSettings

static classRuleSettings: Record<string, ValidationRules>

Defined in: src/base/validator.tsx:1483

---

defaults

static defaults: ValidatorOptions

Defined in: src/base/validator.tsx:269

---

excludedModifierKeys

readonly static excludedModifierKeys: Set<string>

Defined in: src/base/validator.tsx:1727

---

messages

readonly static messages: Record<string, string | Function>

Defined in: src/base/validator.tsx:361

---

methods

readonly static methods: Record<string, ValidationProvider>

Defined in: src/base/validator.tsx:383

Methods

abortRequest()

abortRequest(element): void

Defined in: src/base/validator.tsx:1450

Parameters

element

ValidatableElement

Returns

void

---

check()

check(element): boolean

Defined in: src/base/validator.tsx:1118

Parameters

element

ValidatableElement

Returns

boolean

---

checkForm()

checkForm(): boolean

Defined in: src/base/validator.tsx:892

Returns

boolean

---

customDataMessage()

customDataMessage(element, method): string

Defined in: src/base/validator.tsx:1199

Parameters

element

ValidatableElement

method

string

Returns

string

---

customMessage()

customMessage(name, method): any

Defined in: src/base/validator.tsx:1204

Parameters

name

string

method

string

Returns

any

---

defaultMessage()

defaultMessage(element, rule): any

Defined in: src/base/validator.tsx:1219

Parameters

element

ValidatableElement

rule

method

string

parameters?

any

Returns

any

---

defaultShowErrors()

defaultShowErrors(): void

Defined in: src/base/validator.tsx:1254

Returns

void

---

depend()

depend(param, element): any

Defined in: src/base/validator.tsx:1414

Parameters

param

any

element

ValidatableElement

Returns

any

---

destroy()

destroy(): void

Defined in: src/base/validator.tsx:1476

Returns

void

---

element()

element(element): boolean

Defined in: src/base/validator.tsx:900

Parameters

element

ValidatableElement

Returns

boolean

---

elements()

elements(): ValidatableElement[]

Defined in: src/base/validator.tsx:1041

Returns

ValidatableElement[]

---

errors()

errors(): HTMLElement[]

Defined in: src/base/validator.tsx:1086

Returns

HTMLElement[]

---

errorsFor()

errorsFor(element): HTMLElement[]

Defined in: src/base/validator.tsx:1367

Parameters

element

ValidatableElement

Returns

HTMLElement[]

---

findByName()

findByName(name): ValidatableElement[]

Defined in: src/base/validator.tsx:1398

Parameters

name

string

Returns

ValidatableElement[]

---

findDefined()

findDefined(...args): any

Defined in: src/base/validator.tsx:1210

Parameters

args

...any[]

Returns

any

---

findLastActive()

findLastActive(): ValidatableElement

Defined in: src/base/validator.tsx:1036

Returns

ValidatableElement

---

focusInvalid()

focusInvalid(): void

Defined in: src/base/validator.tsx:1018

Returns

void

---

form()

form(): boolean

Defined in: src/base/validator.tsx:881

Returns

boolean

---

formatAndAdd()

formatAndAdd(element, rule): void

Defined in: src/base/validator.tsx:1241

Parameters

element

ValidatableElement

rule

method

string

parameters

any

Returns

void

---

hideErrors()

hideErrors(): void

Defined in: src/base/validator.tsx:999

Returns

void

---

hideThese()

hideThese(errors): void

Defined in: src/base/validator.tsx:1003

Parameters

errors

HTMLElement[]

Returns

void

---

idOrName()

idOrName(element): string

Defined in: src/base/validator.tsx:1382

Parameters

element

ValidatableElement

Returns

string

---

invalidElements()

invalidElements(): ValidatableElement[]

Defined in: src/base/validator.tsx:1286

Returns

ValidatableElement[]

---

numberOfInvalids()

numberOfInvalids(): number

Defined in: src/base/validator.tsx:981

Returns

number

---

prepareElement()

prepareElement(element): void

Defined in: src/base/validator.tsx:1113

Parameters

element

ValidatableElement

Returns

void

---

prepareForm()

prepareForm(): void

Defined in: src/base/validator.tsx:1108

Returns

void

---

previousValue()

previousValue(element, method): any

Defined in: src/base/validator.tsx:1465

Parameters

element

ValidatableElement

method

string

Returns

any

---

reset()

reset(): void

Defined in: src/base/validator.tsx:1099

Returns

void

---

resetAll()

resetAll(): void

Defined in: src/base/validator.tsx:1104

Returns

void

---

resetElements()

resetElements(elements): void

Defined in: src/base/validator.tsx:965

Parameters

elements

ValidatableElement[]

Returns

void

---

resetForm()

resetForm(): void

Defined in: src/base/validator.tsx:951

Returns

void

---

resetInternals()

resetInternals(): void

Defined in: src/base/validator.tsx:1091

Returns

void

---

showErrors()

showErrors(errors?): void

Defined in: src/base/validator.tsx:930

Parameters

errors?

ValidationErrorMap

Returns

void

---

showLabel()

showLabel(element, message?): void

Defined in: src/base/validator.tsx:1290

Parameters

element

ValidatableElement

message?

string

Returns

void

---

size()

size(): number

Defined in: src/base/validator.tsx:1014

Returns

number

---

startRequest()

startRequest(element): void

Defined in: src/base/validator.tsx:1418

Parameters

element

ValidatableElement

Returns

void

---

stopRequest()

stopRequest(element, valid): void

Defined in: src/base/validator.tsx:1426

Parameters

element

ValidatableElement

valid

boolean

Returns

void

---

valid()

valid(): boolean

Defined in: src/base/validator.tsx:1010

Returns

boolean

---

validationTargetFor()

validationTargetFor(element): ValidatableElement

Defined in: src/base/validator.tsx:1386

Parameters

element

ValidatableElement

Returns

ValidatableElement

---

validElements()

validElements(): ValidatableElement[]

Defined in: src/base/validator.tsx:1281

Returns

ValidatableElement[]

---

addClassRules()

static addClassRules(className, rules): void

Defined in: src/base/validator.tsx:1495

Parameters

className

any

rules

ValidationRules

Returns

void

---

addCustomRule()

static addCustomRule(element, rule, uniqueName?): void

Defined in: src/base/validator.tsx:1697

Parameters

element

HTMLElement | ArrayLike<HTMLElement>

rule

(input) => string

uniqueName?

string

Returns

void

---

addMethod()

static addMethod(name, method, message?): void

Defined in: src/base/validator.tsx:1679

Parameters

name

string

method

ValidationProvider

message?

string

Returns

void

---

attributeRules()

static attributeRules(element): ValidationRules

Defined in: src/base/validator.tsx:1540

Parameters

element

ValidatableElement

Returns

ValidationRules

---

classRules()

static classRules(element): ValidationRules

Defined in: src/base/validator.tsx:1503

Parameters

element

ValidatableElement

Returns

ValidationRules

---

dataRules()

static dataRules(element): object

Defined in: src/base/validator.tsx:1577

Parameters

element

ValidatableElement

Returns

object

---

elementValue()

static elementValue(element): any

Defined in: src/base/validator.tsx:723

Parameters

element

HTMLElement

Returns

any

---

getHighlightTarget()

static getHighlightTarget(el): HTMLElement

Defined in: src/base/validator.tsx:1687

Parameters

el

HTMLElement

Returns

HTMLElement

---

getInstance()

static getInstance(element): Validator

Defined in: src/base/validator.tsx:653

Parameters

element

Node | HTMLFormElement | ArrayLike<HTMLElement>

Returns

Validator

---

getLength()

static getLength(value, element): number

Defined in: src/base/validator.tsx:705

Parameters

value

ValidationValue

element

HTMLElement

Returns

number

---

isCheckOrRadio()

static isCheckOrRadio(element): element is HTMLInputElement

Defined in: src/base/validator.tsx:701

Parameters

element

Node

Returns

element is HTMLInputElement

---

isContentEditable()

static isContentEditable(element): boolean

Defined in: src/base/validator.tsx:718

Parameters

element

HTMLElement

Returns

boolean

---

isValidatableElement()

static isValidatableElement(element): element is ValidatableElement

Defined in: src/base/validator.tsx:697

Checks if element is validatable (input, select, textarea).

Parameters

element

EventTarget

The element to check.

Returns

element is ValidatableElement

true if validatable, otherwise false.

---

normalizeAttributeRule()

static normalizeAttributeRule(rules, type, method, value): void

Defined in: src/base/validator.tsx:1517

Parameters

rules

ValidationRules

type

string

method

string

value

ValidationValue

Returns

void

---

normalizeRules()

static normalizeRules(rules, element): ValidationRules

Defined in: src/base/validator.tsx:1606

Parameters

rules

ValidationRules

element

ValidatableElement

Returns

ValidationRules

---

optional()

static optional(element, value?): "" | "dependency-mismatch"

Defined in: src/base/validator.tsx:261

Parameters

element

ValidatableElement

value?

ValidationValue

Returns

"" | "dependency-mismatch"

---

removeCustomRule()

static removeCustomRule(element, uniqueName): void

Defined in: src/base/validator.tsx:1711

Parameters

element

HTMLElement | ArrayLike<HTMLElement>

uniqueName

string

Returns

void

---

rules()

static rules(element, command?, argument?): ValidationRules

Defined in: src/base/validator.tsx:805

Parameters

element

ValidatableElement

command?

"remove" | "add"

argument?

any

Returns

ValidationRules

---

staticRules()

static staticRules(element): ValidationRules

Defined in: src/base/validator.tsx:1595

Parameters

element

ValidatableElement

Returns

ValidationRules

---

valid()

static valid(element): boolean

Defined in: src/base/validator.tsx:790

Parameters

element

HTMLFormElement | ValidatableElement | ArrayLike<ValidatableElement>

Returns

boolean