get()

Returns the `TypeError` instance of the given unique identification

TypeErrors.prototype.get()

Returns the TypeError instance of the given unique identification id if set, otherwise undefined.

type-errors.class.ts

public get<ErrorId extends Id>(id: ErrorId): TypeError<ErrorId> | undefined {
  return this.errors.get(id);
}

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 range error from the storage.

Parameters

id:ErrorId

The unique identification number of generic type variable ErrorId to pick an error from the object.

Return type

TypeError<ErrorId> |undefined

The return type is the TypeError object that takes the generic type variable ErrorId or undefined.

Returns

The return value is the TypeError instance of the given id if set, otherwise undefined.

Example usage

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

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

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

/*
  Returns TypeError: Problem(TE: 4330): Age is 99 => Fix: Age must be must be of the string
  of type
  TypeError<"(TE: 4330)", undefined> | undefined
*/
typeErrors.get('(TE: 4330)');

// Returns undefined of type TypeError<"(TE: 4332)", undefined> | undefined
typeErrors.get('(TE: 4332)');