set()

Sets the `Error` object under the given `id`

Errors.prototype.set()

Sets the Error object with the message built from the given required problem, fix, id on the given or stored template under the given id.

errors.class.ts

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

Generic type variables

ErrorIdextendsId

A generic type variable ErrorId constrained by the generic type variable Id of the Errors 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.

template =Errors.template

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

Return type

this

Example usage

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

// Define general errors.
const generalErrors = new Errors('EG: 4332', 'EG: 4331', 'EG: 4330');

// Set the `Error` objects under the given identification numbers.
generalErrors
  .set(
    'Bad parameter type, detected number',
    'Provide proper type, the `string`',
    'EG: 4330'
  )
  .set('Detected numbers', 'Provide only letters', 'EG: 4331');