static define()

Defines the `TypeError` instance

TypeError.define()

Defines the TypeError instance with the message built of the given required problem, fix and optional id and type on the given or stored template.

type-error.class.ts

public static define<
  Id extends string,
  Type extends string | undefined = undefined
>(
  problem: string,
  fix: string,
  id?: Id,
  type?: Type,
  template = TypeError.template
): TypeError<Id, Type> {
  return new this(problem, fix, id, type, 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 TypeError instance.

Typeextendsstring|undefined=undefined

A generic type variable constrained by the string and undefined, by default of the value equal to undefined indicates the captured type of the supplied type of a new TypeError instance.

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.

type?:Type

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

template =TypeError.template

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

Return type

TypeError<Id,Type>

The return type is the TypeError object that takes generic type variable Id as identification and generic type variable Type as the type.

Returns

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

Example usage

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

// Returns
// TypeError: Problem(TE:201): Wrong type => Fix: The parameter age type must be of the string
TypeError.define('Wrong type', 'The parameter age type', '(TE:201)', 'string');