static isError()

Checks whether the value of any type is an instance of `Error`.

Error.isError()

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

error.class.ts

public static isError<Id extends string>(
  value: any,
  id?: Id
): value is Error<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 Error via return type.

Parameters

value:any

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

id?:Id

Optional unique identification of generic type variable Id that the given value contains.

Return type

value is Error<Id>

The return type is a boolean resulting from its statement indicating the value is the Error 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 Error of any or the given id.

Example usage

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

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

// Returns true.
Error.isError(err);

// Returns true.
Error.isError(err, 'TE:201');

// Returns false.
Error.isError(err, 'TE:202');

// Returns false.
Error.isError(new Array());