@dwp/govuk-casa
Version:
A framework for building GOVUK Collect-And-Submit-Applications
34 lines (33 loc) • 958 B
TypeScript
/**
* @typedef {import("../../casa").ErrorMessageConfig} ErrorMessageConfig
* @access private
*/
/**
* @typedef {object} EmailConfigOptions
* @property {ErrorMessageConfig} errorMsg Error message config
*/
/**
* Email address.
*
* This is not an exhaustive validation, and is permissive.
*
* See {@link EmailConfigOptions} for `make()` options.
*
* @memberof Validators
* @augments ValidatorFactory
*/
export default class Email extends ValidatorFactory {
/** @property {string} name Validator name ("email") */
name: string;
validate(value: any, dataContext?: {}): ValidationError[];
sanitise(value: any): string | undefined;
}
export type ErrorMessageConfig = import("../../casa").ErrorMessageConfig;
export type EmailConfigOptions = {
/**
* Error message config
*/
errorMsg: ErrorMessageConfig;
};
import ValidatorFactory from "../ValidatorFactory.js";
import ValidationError from "../ValidationError.js";