static isRangeError()

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

RangeError.isRangeError()

Checks whether the value of any type is an instance of RangeError of any or the given minimum/maximum range and identification.

range-error.class.ts

public static isRangeError<
  Id extends string,
  Min extends number | undefined = undefined,
  Max extends number | undefined = undefined
>(
  value: any,
  id?: Id,
  min?: Min,
  max?: Max
): value is RangeError<Id, Min, Max> {
  return (
    super.isError(value, id) &&
    (typeof min === 'number' ? (value as any).min === min : true) &&
    (typeof max === 'number' ? (value as any).max === max : true)
  );
}

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 RangeError via return type.

Minextendsnumber|undefined=undefined

A generic type variable constrained by the number and undefined, by default of the value equal to undefined indicates the captured type of the supplied min via the return type.

Maxextendsnumber|undefined=undefined

A generic type variable constrained by the number and undefined, by default of the value equal to undefined indicates the captured type of the supplied max via the return type.

Parameters

value:any

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

id?:Id

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

min?:Min

The optional minimum range of generic type variable Min that causes an error to be thrown(or not thrown) to check whether the given value contains.

max?:Max

The optional minimum range of generic type variable Max that causes an error to be thrown(or not thrown) to check whether the given value contains.

Return type

value is RangeError<Id,Min,Max>

The return type is a boolean resulting from its statement indicating the value is the RangeError object that takes the generic type variable Id as identification, Min as minimum range and Max as maximum range.

Returns

The return value is a boolean type indicating whether the given value is an instance of RangeError of any or the given optional min, max and id properties.

Example usage

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

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

// Returns true.
RangeError.isRangeError(err);

// Returns true.
RangeError.isRangeError(err, 'TE:201');

// Returns false.
RangeError.isRangeError(err, 'TE:202', 9);

// Returns false.
RangeError.isRangeError(err, 'TE:202', 9, 27);

// Returns false.
RangeError.isRangeError(new Array());