Class EmailCheck

Hierarchy

StringBaseCheck
- EmailCheck

Constructors

constructor

new EmailCheck(key: string | number, data: any): EmailCheck
Parameters
- key: string | number
- data: any
Returns EmailCheck
Overrides StringBaseCheck.constructor
- Defined in checks/email.check.ts:8

Properties

`Protected`valid_type

valid_type: boolean

`Protected`key

key: string | number

`Protected`data

data: any

`Protected`has_value

has_value: boolean

`Protected`out

Methods

email

email(options?: CheckOptions): this
Parameters
- Optionaloptions: CheckOptions
Returns this
- Defined in checks/email.check.ts:22

host

host(oneOf: string[], options?: CheckOptions): this
Parameters
- oneOf: string[]
- Optionaloptions: CheckOptions
Returns this
- Defined in checks/email.check.ts:35

tld

tld(oneOf: string[], options?: CheckOptions): this
Parameters
- oneOf: string[]
- Optionaloptions: CheckOptions
Returns this
- Defined in checks/email.check.ts:50

trim

trim(): this
Returns this
Inherited from StringBaseCheck.trim
- Defined in checks/string.base.check.ts:22

minLength

minLength(length: number, options?: CheckOptions): this
Parameters
- length: number
- Optionaloptions: CheckOptions
Returns this
Inherited from StringBaseCheck.minLength
- Defined in checks/string.base.check.ts:29

maxLength

maxLength(length: number, options?: CheckOptions): this
Parameters
- length: number
- Optionaloptions: CheckOptions
Returns this
Inherited from StringBaseCheck.maxLength
- Defined in checks/string.base.check.ts:38

equalsOneOf

equalsOneOf(values: string[], options?: StringCheckOptions): this
Parameters
- values: string[]
- Optionaloptions: StringCheckOptions
Returns this
Inherited from StringBaseCheck.equalsOneOf
- Defined in checks/string.base.check.ts:47

equals

equals(expected: unknown, options?: EqualityCheckOptions): this
Parameters
- expected: unknown
- Optionaloptions: EqualityCheckOptions
Returns this
Inherited from StringBaseCheck.equals
- Defined in checks/string.base.check.ts:59

startsWith

startsWith(prefix: string, options?: StringCheckOptions): this
Parameters
- prefix: string
- Optionaloptions: StringCheckOptions
Returns this
Inherited from StringBaseCheck.startsWith
- Defined in checks/string.base.check.ts:69

endsWith

endsWith(suffix: string, options?: StringCheckOptions): this
Parameters
- suffix: string
- Optionaloptions: StringCheckOptions
Returns this
Inherited from StringBaseCheck.endsWith
- Defined in checks/string.base.check.ts:81

contains

contains(substring: string, options?: StringCheckOptions): this
Parameters
- substring: string
- Optionaloptions: StringCheckOptions
Returns this
Inherited from StringBaseCheck.contains
- Defined in checks/string.base.check.ts:93

pattern

pattern(regex: RegExp, options?: CheckOptions): this
Parameters
- regex: RegExp
- Optionaloptions: CheckOptions
Returns this
Inherited from StringBaseCheck.pattern
- Defined in checks/string.base.check.ts:106

inherit

inherit(priors: IResult): this
Parameters
- priors: IResult
Returns this
Inherited from StringBaseCheck.inherit
- Defined in checks/value.check.ts:25

isTrue

isTrue(
func: (data: any) => boolean | Promise<boolean>,
options?: CheckOptions,
): Promise<EmailCheck>
Parameters
- func: (data: any) => boolean | Promise<boolean>
- Optionaloptions: CheckOptions
Returns Promise<EmailCheck>
Inherited from StringBaseCheck.isTrue
- Defined in checks/value.check.ts:55

`Protected`errorMessage

errorMessage(err: string, options?: CheckOptions): void
Parameters
- err: string
- Optionaloptions: CheckOptions
Returns void
Inherited from StringBaseCheck.errorMessage
- Defined in checks/value.check.ts:66

`Protected`normalizeEqualityValues

normalizeEqualityValues(
    actual: unknown,
    expected: unknown,
    options?: EqualityCheckOptions,
): { actual: unknown; expected: unknown }
Parameters
- actual: unknown
- expected: unknown
- Optionaloptions: EqualityCheckOptions
Returns { actual: unknown; expected: unknown }
Inherited from StringBaseCheck.normalizeEqualityValues
- Defined in checks/value.check.ts:70

`Protected`equalityMatches

equalityMatches(
    actual: unknown,
    expected: unknown,
    options?: EqualityCheckOptions,
): boolean
Parameters
- actual: unknown
- expected: unknown
- Optionaloptions: EqualityCheckOptions
Returns boolean
Inherited from StringBaseCheck.equalityMatches
- Defined in checks/value.check.ts:89

`Protected`rules

rules(field_checks: (Check | Promise<Check>)[]): Promise<EmailCheck>
Parameters
- field_checks: (Check | Promise<Check>)[]
Returns Promise<EmailCheck>
Inherited from StringBaseCheck.rules
- Defined in checks/value.check.ts:97

`Protected`composeAlternatives

composeAlternatives(
mode: "anyOf" | "oneOf",
branches: ((checker: this) => (Check | Promise<Check>)[])[],
): Promise<EmailCheck>
Parameters
- mode: "anyOf" | "oneOf"
- branches: ((checker: this) => (Check | Promise<Check>)[])[]
Returns Promise<EmailCheck>
Inherited from StringBaseCheck.composeAlternatives
- Defined in checks/value.check.ts:117

not

not(
func: (checker: this) => (Check | Promise<Check>)[],
options?: CheckOptions,
): Promise<EmailCheck>
Parameters
- func: (checker: this) => (Check | Promise<Check>)[]
- Optionaloptions: CheckOptions
Returns Promise<EmailCheck>
Inherited from StringBaseCheck.not
- Defined in checks/value.check.ts:169

`Protected`createAlternativeChecker

createAlternativeChecker(): this
Returns this
Inherited from StringBaseCheck.createAlternativeChecker
- Defined in checks/value.check.ts:183

`Protected`cloneAlternativeValue

cloneAlternativeValue<T>(value: T): T
Type Parameters
- T
Parameters
- value: T
Returns T
Inherited from StringBaseCheck.cloneAlternativeValue
- Defined in checks/value.check.ts:188

`Protected`mergeBranchResult

mergeBranchResult(result: IResult): void
Parameters
- result: IResult
Returns void
Inherited from StringBaseCheck.mergeBranchResult
- Defined in checks/value.check.ts:208

`Protected`mergeMessageValue

mergeMessageValue(
current?: string | string[],
incoming?: string | string[],
): string | string[] | undefined
Parameters
- Optionalcurrent: string | string[]
- Optionalincoming: string | string[]
Returns string | string[] | undefined
Inherited from StringBaseCheck.mergeMessageValue
- Defined in checks/value.check.ts:236

`Protected`toArray

toArray(value?: string | string[]): string[]
Parameters
- Optionalvalue: string | string[]
Returns string[]
Inherited from StringBaseCheck.toArray
- Defined in checks/value.check.ts:250

result

result(options?: ResultOptions): IResult
Builds the validation result for the current check.
Parameters
- Optionaloptions: ResultOptions
Returns IResult
Inherited from StringBaseCheck.result
- Defined in checks/value.check.ts:258