@serenity-is/corelib / Validator
Class: Validator
Table of contents
Constructors
Properties
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
Defined in
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
lastActive
• lastActive: ValidatableElement
Defined in
settings
• Readonly
settings: ValidatorOptions
Defined in
autoCreateRanges
▪ Static
autoCreateRanges: boolean
= false
Defined in
classRuleSettings
▪ Static
classRuleSettings: Record
<string
, ValidationRules
>
Defined in
defaults
▪ Static
defaults: ValidatorOptions
Defined in
messages
▪ Static
Readonly
messages: Record
<string
, string
| Function
>
Defined in
methods
▪ Static
Readonly
methods: Record
<string
, ValidationProvider
>
Defined in
Methods
abortRequest
▸ abortRequest(element
): void
Parameters
Name | Type |
---|---|
element |
ValidatableElement |
Returns
void
Defined in
check
▸ check(element
): boolean
Parameters
Name | Type |
---|---|
element |
ValidatableElement |
Returns
boolean
Defined in
checkForm
▸ checkForm(): boolean
Returns
boolean
Defined in
customDataMessage
▸ customDataMessage(element
, method
): string
Parameters
Name | Type |
---|---|
element |
ValidatableElement |
method |
string |
Returns
string
Defined in
customMessage
▸ customMessage(name
, method
): any
Parameters
Name | Type |
---|---|
name |
string |
method |
string |
Returns
any
Defined in
defaultMessage
▸ defaultMessage(element
, rule
): any
Parameters
Name | Type |
---|---|
element |
ValidatableElement |
rule |
Object |
rule.method |
string |
rule.parameters? |
any |
Returns
any
Defined in
defaultShowErrors
▸ defaultShowErrors(): void
Returns
void
Defined in
depend
▸ depend(param
, element
): any
Parameters
Name | Type |
---|---|
param |
any |
element |
ValidatableElement |
Returns
any
Defined in
destroy
▸ destroy(): void
Returns
void
Defined in
element
▸ element(element
): boolean
Parameters
Name | Type |
---|---|
element |
ValidatableElement |
Returns
boolean
Defined in
elements
▸ elements(): ValidatableElement
[]
Returns
Defined in
errors
▸ errors(): HTMLElement
[]
Returns
HTMLElement
[]
Defined in
errorsFor
▸ errorsFor(element
): HTMLElement
[]
Parameters
Name | Type |
---|---|
element |
ValidatableElement |
Returns
HTMLElement
[]
Defined in
findByName
▸ findByName(name
): ValidatableElement
[]
Parameters
Name | Type |
---|---|
name |
string |
Returns
Defined in
findDefined
▸ findDefined(...args
): any
Parameters
Name | Type |
---|---|
...args |
any [] |
Returns
any
Defined in
findLastActive
▸ findLastActive(): ValidatableElement
Returns
Defined in
focusInvalid
▸ focusInvalid(): void
Returns
void
Defined in
form
▸ form(): boolean
Returns
boolean
Defined in
formatAndAdd
▸ formatAndAdd(element
, rule
): void
Parameters
Name | Type |
---|---|
element |
ValidatableElement |
rule |
Object |
rule.method |
string |
rule.parameters |
any |
Returns
void
Defined in
hideErrors
▸ hideErrors(): void
Returns
void
Defined in
hideThese
▸ hideThese(errors
): void
Parameters
Name | Type |
---|---|
errors |
HTMLElement [] |
Returns
void
Defined in
idOrName
▸ idOrName(element
): string
Parameters
Name | Type |
---|---|
element |
ValidatableElement |
Returns
string
Defined in
invalidElements
▸ invalidElements(): ValidatableElement
[]
Returns
Defined in
numberOfInvalids
▸ numberOfInvalids(): number
Returns
number
Defined in
prepareElement
▸ prepareElement(element
): void
Parameters
Name | Type |
---|---|
element |
ValidatableElement |
Returns
void
Defined in
prepareForm
▸ prepareForm(): void
Returns
void
Defined in
previousValue
▸ previousValue(element
, method
): any
Parameters
Name | Type |
---|---|
element |
ValidatableElement |
method |
string |
Returns
any
Defined in
reset
▸ reset(): void
Returns
void
Defined in
resetAll
▸ resetAll(): void
Returns
void
Defined in
resetElements
▸ resetElements(elements
): void
Parameters
Name | Type |
---|---|
elements |
ValidatableElement [] |
Returns
void
Defined in
resetForm
▸ resetForm(): void
Returns
void
Defined in
resetInternals
▸ resetInternals(): void
Returns
void
Defined in
showErrors
▸ showErrors(errors?
): void
Parameters
Name | Type |
---|---|
errors? |
ValidationErrorMap |
Returns
void
Defined in
showLabel
▸ showLabel(element
, message?
): void
Parameters
Name | Type |
---|---|
element |
ValidatableElement |
message? |
string |
Returns
void
Defined in
size
▸ size(): number
Returns
number
Defined in
startRequest
▸ startRequest(element
): void
Parameters
Name | Type |
---|---|
element |
ValidatableElement |
Returns
void
Defined in
stopRequest
▸ stopRequest(element
, valid
): void
Parameters
Name | Type |
---|---|
element |
ValidatableElement |
valid |
boolean |
Returns
void
Defined in
valid
▸ valid(): boolean
Returns
boolean
Defined in
validElements
▸ validElements(): ValidatableElement
[]
Returns
Defined in
validationTargetFor
▸ validationTargetFor(element
): ValidatableElement
Parameters
Name | Type |
---|---|
element |
ValidatableElement |
Returns
Defined in
addClassRules
▸ addClassRules(className
, rules
): void
Parameters
Name | Type |
---|---|
className |
any |
rules |
ValidationRules |
Returns
void
Defined in
addMethod
▸ addMethod(name
, method
, message?
): void
Parameters
Name | Type |
---|---|
name |
string |
method |
ValidationProvider |
message? |
string |
Returns
void
Defined in
attributeRules
▸ attributeRules(element
): ValidationRules
Parameters
Name | Type |
---|---|
element |
ValidatableElement |
Returns
Defined in
classRules
▸ classRules(element
): ValidationRules
Parameters
Name | Type |
---|---|
element |
ValidatableElement |
Returns
Defined in
dataRules
▸ dataRules(element
): Object
Parameters
Name | Type |
---|---|
element |
ValidatableElement |
Returns
Object
Defined in
elementValue
▸ elementValue(element
): string
| number
| string
[]
Parameters
Name | Type |
---|---|
element |
HTMLElement |
Returns
string
| number
| string
[]
Defined in
getHighlightTarget
▸ getHighlightTarget(el
): HTMLElement
Parameters
Name | Type |
---|---|
el |
HTMLElement |
Returns
HTMLElement
Defined in
getInstance
▸ getInstance(element
): Validator
Parameters
Name | Type |
---|---|
element |
Node | HTMLFormElement | ArrayLike <HTMLElement > |
Returns
Defined in
getLength
▸ getLength(value
, element
): number
Parameters
Name | Type |
---|---|
value |
ValidationValue |
element |
HTMLElement |
Returns
number
Defined in
isCheckOrRadio
▸ isCheckOrRadio(element
): element is HTMLInputElement
Parameters
Name | Type |
---|---|
element |
Node |
Returns
element is HTMLInputElement
Defined in
isContentEditable
▸ isContentEditable(element
): boolean
Parameters
Name | Type |
---|---|
element |
HTMLElement |
Returns
boolean
Defined in
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
normalizeAttributeRule
▸ normalizeAttributeRule(rules
, type
, method
, value
): void
Parameters
Name | Type |
---|---|
rules |
ValidationRules |
type |
string |
method |
string |
value |
ValidationValue |
Returns
void
Defined in
normalizeRules
▸ normalizeRules(rules
, element
): ValidationRules
Parameters
Name | Type |
---|---|
rules |
ValidationRules |
element |
ValidatableElement |
Returns
Defined in
optional
▸ optional(element
): ""
| "dependency-mismatch"
Parameters
Name | Type |
---|---|
element |
ValidatableElement |
Returns
""
| "dependency-mismatch"
Defined in
rules
▸ rules(element
, command?
, argument?
): Record
<string
, any
>
Parameters
Name | Type |
---|---|
element |
ValidatableElement |
command? |
"remove" | "add" |
argument? |
any |
Returns
Record
<string
, any
>
Defined in
staticRules
▸ staticRules(element
): ValidationRules
Parameters
Name | Type |
---|---|
element |
ValidatableElement |
Returns
Defined in
valid
▸ valid(element
): boolean
Parameters
Name | Type |
---|---|
element |
HTMLFormElement | ValidatableElement | ArrayLike <ValidatableElement > |
Returns
boolean