@serenity-is/corelib / Validator

Class: Validator

Table of contents

Constructors

• constructor

Properties

• dependTypes
• lastActive
• settings
• autoCreateRanges
• classRuleSettings
• defaults
• messages
• methods

Methods

• abortRequest
• check
• checkForm
• customDataMessage
• customMessage
• defaultMessage
• defaultShowErrors
• depend
• destroy
• element
• elements
• errors
• errorsFor
• findByName
• findDefined
• findLastActive
• focusInvalid
• form
• formatAndAdd
• hideErrors
• hideThese
• idOrName
• invalidElements
• numberOfInvalids
• prepareElement
• prepareForm
• previousValue
• reset
• resetAll
• resetElements
• resetForm
• resetInternals
• showErrors
• showLabel
• size
• startRequest
• stopRequest
• valid
• validElements
• validationTargetFor
• addClassRules
• addMethod
• attributeRules
• classRules
• dataRules
• elementValue
• getHighlightTarget
• getInstance
• getLength
• isCheckOrRadio
• isContentEditable
• isValidatableElement
• normalizeAttributeRule
• normalizeRules
• optional
• rules
• staticRules
• valid

Constructors

constructor

• new Validator(form, options): Validator

Parameters

Name	Type
form	HTMLFormElement
options	ValidatorOptions

Returns

Validator

Defined in

src/base/validator.ts:528

Properties

dependTypes

• dependTypes: Object

Type declaration

Name	Type
boolean	(param: any) => any
function	(param: any, element: ValidatableElement) => any
string	(param: any, element: ValidatableElement) => boolean

Defined in

src/base/validator.ts:1376

---

lastActive

• lastActive: ValidatableElement

Defined in

src/base/validator.ts:512

---

settings

• Readonly settings: ValidatorOptions

Defined in

src/base/validator.ts:511

---

autoCreateRanges

▪ Static autoCreateRanges: boolean = false

Defined in

src/base/validator.ts:259

---

classRuleSettings

▪ Static classRuleSettings: Record<string, ValidationRules>

Defined in

src/base/validator.ts:1457

---

defaults

▪ Static defaults: ValidatorOptions

Defined in

src/base/validator.ts:261

---

messages

▪ Static Readonly messages: Record<string, string | Function>

Defined in

src/base/validator.ts:341

---

methods

▪ Static Readonly methods: Record<string, ValidationProvider>

Defined in

src/base/validator.ts:363

Methods

abortRequest

▸ abortRequest(element): void

Parameters

Name	Type
element	ValidatableElement

Returns

void

Defined in

src/base/validator.ts:1424

---

check

▸ check(element): boolean

Parameters

Name	Type
element	ValidatableElement

Returns

boolean

Defined in

src/base/validator.ts:1093

---

checkForm

▸ checkForm(): boolean

Returns

boolean

Defined in

src/base/validator.ts:865

---

customDataMessage

▸ customDataMessage(element, method): string

Parameters

Name	Type
element	ValidatableElement
method	string

Returns

string

Defined in

src/base/validator.ts:1174

---

customMessage

▸ customMessage(name, method): any

Parameters

Name	Type
name	string
method	string

Returns

any

Defined in

src/base/validator.ts:1179

---

defaultMessage

▸ defaultMessage(element, rule): any

Parameters

Name	Type
element	ValidatableElement
rule	Object
rule.method	string
rule.parameters?	any

Returns

any

Defined in

src/base/validator.ts:1194

---

defaultShowErrors

▸ defaultShowErrors(): void

Returns

void

Defined in

src/base/validator.ts:1229

---

depend

▸ depend(param, element): any

Parameters

Name	Type
param	any
element	ValidatableElement

Returns

any

Defined in

src/base/validator.ts:1388

---

destroy

▸ destroy(): void

Returns

void

Defined in

src/base/validator.ts:1450

---

element

▸ element(element): boolean

Parameters

Name	Type
element	ValidatableElement

Returns

boolean

Defined in

src/base/validator.ts:873

---

elements

▸ elements(): ValidatableElement[]

Returns

ValidatableElement[]

Defined in

src/base/validator.ts:1016

---

errors

▸ errors(): HTMLElement[]

Returns

HTMLElement[]

Defined in

src/base/validator.ts:1061

---

errorsFor

▸ errorsFor(element): HTMLElement[]

Parameters

Name	Type
element	ValidatableElement

Returns

HTMLElement[]

Defined in

src/base/validator.ts:1341

---

findByName

▸ findByName(name): ValidatableElement[]

Parameters

Name	Type
name	string

Returns

ValidatableElement[]

Defined in

src/base/validator.ts:1372

---

findDefined

▸ findDefined(...args): any

Parameters

Name	Type
...args	any[]

Returns

any

Defined in

src/base/validator.ts:1185

---

findLastActive

▸ findLastActive(): ValidatableElement

Returns

ValidatableElement

Defined in

src/base/validator.ts:1011

---

focusInvalid

▸ focusInvalid(): void

Returns

void

Defined in

src/base/validator.ts:993

---

form

▸ form(): boolean

Returns

boolean

Defined in

src/base/validator.ts:854

---

formatAndAdd

▸ formatAndAdd(element, rule): void

Parameters

Name	Type
element	ValidatableElement
rule	Object
rule.method	string
rule.parameters	any

Returns

void

Defined in

src/base/validator.ts:1216

---

hideErrors

▸ hideErrors(): void

Returns

void

Defined in

src/base/validator.ts:974

---

hideThese

▸ hideThese(errors): void

Parameters

Name	Type
errors	HTMLElement[]

Returns

void

Defined in

src/base/validator.ts:978

---

idOrName

▸ idOrName(element): string

Parameters

Name	Type
element	ValidatableElement

Returns

string

Defined in

src/base/validator.ts:1356

---

invalidElements

▸ invalidElements(): ValidatableElement[]

Returns

ValidatableElement[]

Defined in

src/base/validator.ts:1261

---

numberOfInvalids

▸ numberOfInvalids(): number

Returns

number

Defined in

src/base/validator.ts:955

---

prepareElement

▸ prepareElement(element): void

Parameters

Name	Type
element	ValidatableElement

Returns

void

Defined in

src/base/validator.ts:1088

---

prepareForm

▸ prepareForm(): void

Returns

void

Defined in

src/base/validator.ts:1083

---

previousValue

▸ previousValue(element, method): any

Parameters

Name	Type
element	ValidatableElement
method	string

Returns

any

Defined in

src/base/validator.ts:1439

---

reset

▸ reset(): void

Returns

void

Defined in

src/base/validator.ts:1074

---

resetAll

▸ resetAll(): void

Returns

void

Defined in

src/base/validator.ts:1079

---

resetElements

▸ resetElements(elements): void

Parameters

Name	Type
elements	ValidatableElement[]

Returns

void

Defined in

src/base/validator.ts:939

---

resetForm

▸ resetForm(): void

Returns

void

Defined in

src/base/validator.ts:925

---

resetInternals

▸ resetInternals(): void

Returns

void

Defined in

src/base/validator.ts:1066

---

showErrors

▸ showErrors(errors?): void

Parameters

Name	Type
errors?	ValidationErrorMap

Returns

void

Defined in

src/base/validator.ts:904

---

showLabel

▸ showLabel(element, message?): void

Parameters

Name	Type
element	ValidatableElement
message?	string

Returns

void

Defined in

src/base/validator.ts:1265

---

size

▸ size(): number

Returns

number

Defined in

src/base/validator.ts:989

---

startRequest

▸ startRequest(element): void

Parameters

Name	Type
element	ValidatableElement

Returns

void

Defined in

src/base/validator.ts:1392

---

stopRequest

▸ stopRequest(element, valid): void

Parameters

Name	Type
element	ValidatableElement
valid	boolean

Returns

void

Defined in

src/base/validator.ts:1400

---

valid

▸ valid(): boolean

Returns

boolean

Defined in

src/base/validator.ts:985

---

validElements

▸ validElements(): ValidatableElement[]

Returns

ValidatableElement[]

Defined in

src/base/validator.ts:1256

---

validationTargetFor

▸ validationTargetFor(element): ValidatableElement

Parameters

Name	Type
element	ValidatableElement

Returns

ValidatableElement

Defined in

src/base/validator.ts:1360

---

addClassRules

▸ addClassRules(className, rules): void

Parameters

Name	Type
className	any
rules	ValidationRules

Returns

void

Defined in

src/base/validator.ts:1469

---

addMethod

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

Parameters

Name	Type
name	string
method	ValidationProvider
message?	string

Returns

void

Defined in

src/base/validator.ts:1652

---

attributeRules

▸ attributeRules(element): ValidationRules

Parameters

Name	Type
element	ValidatableElement

Returns

ValidationRules

Defined in

src/base/validator.ts:1514

---

classRules

▸ classRules(element): ValidationRules

Parameters

Name	Type
element	ValidatableElement

Returns

ValidationRules

Defined in

src/base/validator.ts:1477

---

dataRules

▸ dataRules(element): Object

Parameters

Name	Type
element	ValidatableElement

Returns

Object

Defined in

src/base/validator.ts:1550

---

elementValue

▸ elementValue(element): string | number | string[]

Parameters

Name	Type
element	HTMLElement

Returns

string | number | string[]

Defined in

src/base/validator.ts:698

---

getHighlightTarget

▸ getHighlightTarget(el): HTMLElement

Parameters

Name	Type
el	HTMLElement

Returns

HTMLElement

Defined in

src/base/validator.ts:1660

---

getInstance

▸ getInstance(element): Validator

Parameters

Name	Type
element	Node | HTMLFormElement | ArrayLike<HTMLElement>

Returns

Validator

Defined in

src/base/validator.ts:628

---

getLength

▸ getLength(value, element): number

Parameters

Name	Type
value	ValidationValue
element	HTMLElement

Returns

number

Defined in

src/base/validator.ts:680

---

isCheckOrRadio

▸ isCheckOrRadio(element): element is HTMLInputElement

Parameters

Name	Type
element	Node

Returns

element is HTMLInputElement

Defined in

src/base/validator.ts:676

---

isContentEditable

▸ isContentEditable(element): boolean

Parameters

Name	Type
element	HTMLElement

Returns

boolean

Defined in

src/base/validator.ts:693

---

isValidatableElement

▸ isValidatableElement(element): element is ValidatableElement

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

Parameters

Name	Type	Description
element	EventTarget	The element to check.

Returns

element is ValidatableElement

true if validatable, otherwise false.

Defined in

src/base/validator.ts:672

---

normalizeAttributeRule

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

Parameters

Name	Type
rules	ValidationRules
type	string
method	string
value	ValidationValue

Returns

void

Defined in

src/base/validator.ts:1491

---

normalizeRules

▸ normalizeRules(rules, element): ValidationRules

Parameters

Name	Type
rules	ValidationRules
element	ValidatableElement

Returns

ValidationRules

Defined in

src/base/validator.ts:1579

---

optional

▸ optional(element): "" | "dependency-mismatch"

Parameters

Name	Type
element	ValidatableElement

Returns

"" | "dependency-mismatch"

Defined in

src/base/validator.ts:254

---

rules

▸ rules(element, command?, argument?): Record<string, any>

Parameters

Name	Type
element	ValidatableElement
command?	"remove" | "add"
argument?	any

Returns

Record<string, any>

Defined in

src/base/validator.ts:779

---

staticRules

▸ staticRules(element): ValidationRules

Parameters

Name	Type
element	ValidatableElement

Returns

ValidationRules

Defined in

src/base/validator.ts:1568

---

valid

▸ valid(element): boolean

Parameters

Name	Type
element	HTMLFormElement | ValidatableElement | ArrayLike<ValidatableElement>

Returns

boolean

Defined in

src/base/validator.ts:764