get()

Returns the `Error` instance of the given unique identification

Errors.prototype.get()

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

errors.class.ts
public get<ErrorId extends Id>(id: ErrorId): Error<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 error from the storage.

Parameters

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

Return type

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

Returns

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

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');

// Returns the Error<"EG: 4330">.
generalErrors.get('EG: 4330');

Last updated