@angular/forms/signals

emailError

function

stablesince v22.0

Create an email format error associated with the target field

API

function emailError(
  options: WithFieldTree<ValidationErrorOptions>,
): EmailValidationError;
function emailError(
  options?: ValidationErrorOptions | undefined,
): WithoutFieldTree<EmailValidationError>;

function emailError(options: WithFieldTree<ValidationErrorOptions>): EmailValidationError;

Create an email format error associated with the target field

@paramoptionsWithFieldTree<ValidationErrorOptions>

The validation error options

@returnsEmailValidationError

function emailError(options?: ValidationErrorOptions | undefined): WithoutFieldTree<EmailValidationError>;

Create an email format error

@paramoptionsValidationErrorOptions | undefined

The optional validation error options

@returnsWithoutFieldTree<EmailValidationError>