@serenity-is/corelib / CompareValidationRule
Class: CompareValidationRule
Defined in: src/ui/helpers/builtinvalidationrules.ts:108
Requires the same value as another field, the name of which is the parameter, an empty one being the same as another.
Extends
Constructors
Constructor
new CompareValidationRule():
CompareValidationRule
Returns
CompareValidationRule
Inherited from
Properties
defaultText
defaultText:
string="Please enter the same value again."
Defined in: src/ui/helpers/builtinvalidationrules.ts:111
The text of the message for when its key has no text, e.g. the English one.
Overrides
textKey
textKey:
string="Validation.Compare"
Defined in: src/ui/helpers/builtinvalidationrules.ts:110
The local text key of the message of the rule, which can have the parameters of the rule as {0}, {1}, used when
the attribute gives no message of its own.
Overrides
[typeInfo]
static[typeInfo]:ClassTypeInfo<"Serenity.">
Defined in: src/ui/helpers/builtinvalidationrules.ts:109
Overrides
Methods
check()
check(
value,params,context):boolean
Defined in: src/ui/helpers/builtinvalidationrules.ts:113
Checks a value by the rule. It is not called for an empty value, i.e. null, an empty string or an empty list, as being required is a rule of its own.
Parameters
value
any
The value, e.g. a number for a decimal editor, or a text.
params
string
The parameters of the rule, as the server sends them.
context
The element and the other fields.
Returns
boolean
Whether the value is valid.
Overrides
getDefaultText()
getDefaultText(
params):string
Defined in: src/base/validationrule.ts:59
Gets the text of the message for when its key has no text, by default defaultText.
Parameters
params
any
The parameters of the rule.
Returns
string
Inherited from
getMessageArgs()
getMessageArgs():
any[]
Defined in: src/ui/helpers/builtinvalidationrules.ts:124
Gets what the message has as {0}, {1} and so on, by default the parameters of the rule.
Returns
any[]
Overrides
getTextKey()
getTextKey(
params):string
Defined in: src/base/validationrule.ts:51
Gets the local text key of the message, by default textKey, which a rule can choose by its parameters, e.g. a length rule by whether it has a minimum.
Parameters
params
any
The parameters of the rule.
Returns
string
Inherited from
registerRule()
protectedstaticregisterRule<TypeName>(typeName):ClassTypeInfo<TypeName>
Defined in: src/base/validationrule.ts:75
Registers a rule class by its type key, e.g. this.registerRule("MyApp.") for MyApp.EvenValidationRule.
Type Parameters
TypeName
TypeName
Parameters
typeName
StringLiteral<TypeName>
The full name of the type, or its namespace ending with a dot.
Returns
ClassTypeInfo<TypeName>