@angular/forms/signals

maxLengthError

function

API

function maxLengthError(
  maxLength: number,
  options: WithField<ValidationErrorOptions>,
): MaxLengthValidationError;
function maxLengthError(
  maxLength: number,
  options?: ValidationErrorOptions | undefined,
): WithoutField<MaxLengthValidationError>;

function maxLengthError(maxLength: number, options: WithField<ValidationErrorOptions>): MaxLengthValidationError;

Create a maxLength error associated with the target field

@parammaxLengthnumber

The maxLength constraint

@paramoptionsWithField<ValidationErrorOptions>

The validation error options

@returnsMaxLengthValidationError

function maxLengthError(maxLength: number, options?: ValidationErrorOptions | undefined): WithoutField<MaxLengthValidationError>;

Create a maxLength error

@parammaxLengthnumber

The maxLength constraint

@paramoptionsValidationErrorOptions | undefined

The optional validation error options

@returnsWithoutField<MaxLengthValidationError>