static define()

Defines the `RangeError` instance.

RangeError.define()

Defines the RangeError instance with the message built from the given required problem, fix and optional id, max, min on the given or stored template.

range-error.class.ts

public static define<
  Id extends string,
  Min extends number | undefined = undefined,
  Max extends number | undefined = undefined
>(
  problem: string,
  fix: string,
  id?: Id,
  min?: Min,
  max?: Max,
  template = RangeError.template
): RangeError<Id, Min, Max> {
  return new this(problem, fix, id, min, max, template);
}

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 a new RangeError instance.

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

problem:string

Description of the problem of a string type.

fix:string

A solution to the given problem of a string type.

id?:Id

Optional unique identification to the given problem of generic type variable Id.

min?:Min

The optional minimum range of generic type variable Min that causes an error to be thrown(or not thrown).

max?:Max

The optional maximum range of generic type variable Max that causes an error to be thrown(or not thrown).

template =RangeError.template

A template of error message with the replaceable {problem}, {fix} and optional {id}, {max}, {min} tags. By default, the value is equal to the static property RangeError.template.

Return type

RangeError<Id,Min,Max>

The return type is the RangeError object that takes generic type variable Id as identification, Min as minimum range and Max as maximum range.

Returns

The return value is a new instance of the RangeError with the message built from the given required problem, fix and optional id, min, max on the given or stored template.

Example usage

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

// Returns
// RangeError: ProblemTE:201: Wrong age => Fix: The value must be between 9 and 27
RangeError.define('Wrong age', 'The value must be', 'TE:201', 9, 27);