set()

Sets the `TypeError` object under the given `id`

TypeErrors.prototype.set()

Sets the TypeError object with the message built from the given required problem, fix, id and optional type on the given or stored template under the given id.

type-errors.class.ts

public set<ErrorId extends Id>(
  problem: string,
  fix: string,
  id: ErrorId,
  type?: string,
  template = TypeErrors.template
): this {
  this.isAllowedId(id) &&
    this.errors.set(id, new TypeError(problem, fix, id, type, template));
  return this;
}

Generic type variables

ErrorIdextendsId

A generic type variable ErrorId constrained by the generic type variable Id of the TypeErrors object indicates the type picked from the Id and its exact type is useful in picking the specific error from the storage.

Parameters

problem:string

Description of the problem of a string type.

fix:string

A solution to the given problem of a string type.

id:ErrorId

The unique identification to the given problem of generic type variable ErrorId.

type?:string

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

template =TypeErrors.template

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

Return type

this

Example usage

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

// Define type errors.
const typeErrors = new RangeErrors('RE: 4332', 'RE: 4331', 'RE: 4330');

// Set the `TypeErrors` objects under the given identification numbers.
typeErrors
  .set(
    'Age is 99 string type',
    'Age must be',
    '(TE: 4330)',
    'number'
  )
  .set('Detected numbers', 'Provide only letters', '(TE: 4330)');