@angular/forms/signals

patternError

function

API

function patternError(
  pattern: RegExp,
  options: WithFieldTree<ValidationErrorOptions>,
): PatternValidationError;
function patternError(
  pattern: RegExp,
  options?: ValidationErrorOptions | undefined,
): WithoutFieldTree<PatternValidationError>;

function patternError(pattern: RegExp, options: WithFieldTree<ValidationErrorOptions>): PatternValidationError;

Create a pattern matching error associated with the target field

@parampatternRegExp

The violated pattern

@paramoptionsWithFieldTree<ValidationErrorOptions>

The validation error options

@returnsPatternValidationError

function patternError(pattern: RegExp, options?: ValidationErrorOptions | undefined): WithoutFieldTree<PatternValidationError>;

Create a pattern matching error

@parampatternRegExp

The violated pattern

@paramoptionsValidationErrorOptions | undefined

The optional validation error options

@returnsWithoutFieldTree<PatternValidationError>