static isValidationError()

Checks whether the value of any type is an instance of `ValidationError`

ValidationError.isValidationError()

Checks whether the value of any type is the ValidationError instance of any or the given identification.

validation-error.class.ts

public static isValidationError<Id extends string>(
  value: any,
  id?: Id
): value is ValidationError<Id> {
  return super.isError(value, id);
}

Generic type variables

Idextendsstring

A generic type variable constrained by the string, by default of the value captured from the provided optional id indicates the identification type of the ValidationError via return type.

Parameters

value:any

The value of any type to check against the ValidationError instance.

id?:Id

Optional unique identification of generic type variable Id to check whether the given value contains.

Return type

value is ValidationError<Id>

The return type is a boolean resulting from its statement indicating the value is the ValidationError object that takes the generic type variable Id.

Returns

The return value is a boolean type indicating whether the given value is an instance of ValidationError of any or the supplied optional id properties.

Example usage

// Example usage.
import { ValidationError } from '@angular-package/error';

// Define error.
const err = ValidationError.define('Wrong type', 'Change the type', 'TE:201');

// Returns true.
ValidationError.isValidationError(err);

// Returns true.
ValidationError.isValidationError(err, 'TE:201');

// Returns true.
ValidationError.isValidationError(err, 'TE:201');

// Returns false.
ValidationError.isValidationError(err, 'TE:202');

// Returns false.
ValidationError.isValidationError(new Array());