Skip to content

@serenity-is/corelib / EmailValidationRule

Class: EmailValidationRule

Defined in: src/ui/helpers/builtinvalidationrules.ts:86

Requires an email address, as the email class of the validator does.

Extends

Constructors

Constructor

new EmailValidationRule(): EmailValidationRule

Returns

EmailValidationRule

Inherited from

ValidationRule.constructor

Properties

defaultText

defaultText: string = "Please enter a valid email address."

Defined in: src/ui/helpers/builtinvalidationrules.ts:89

The text of the message for when its key has no text, e.g. the English one.

Overrides

ValidationRule.defaultText


textKey

textKey: string = "Validation.Email"

Defined in: src/ui/helpers/builtinvalidationrules.ts:88

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

ValidationRule.textKey


[typeInfo]

static [typeInfo]: ClassTypeInfo<"Serenity.">

Defined in: src/ui/helpers/builtinvalidationrules.ts:87

Overrides

ValidationRule.[typeInfo]

Methods

check()

check(value, _, context): boolean

Defined in: src/ui/helpers/builtinvalidationrules.ts:91

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.

_

any

context

ValidationRuleContext

The element and the other fields.

Returns

boolean

Whether the value is valid.

Overrides

ValidationRule.check


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

ValidationRule.getDefaultText


getMessageArgs()

getMessageArgs(params): any[]

Defined in: src/base/validationrule.ts:67

Gets what the message has as {0}, {1} and so on, by default the parameters of the rule.

Parameters

params

any

The parameters of the rule.

Returns

any[]

Inherited from

ValidationRule.getMessageArgs


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

ValidationRule.getTextKey


registerRule()

protected static registerRule<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>

Inherited from

ValidationRule.registerRule