angular-package
PatreonTwitternpmGitHub
Error
Error
  • Introduction
  • ❤ Benefits
  • General concepts
  • Getting started
    • Skeleton
    • Installation
      • npm
    • Public API
    • Basic concepts
  • CommonError {}
    • Overview
    • Generic type variables
    • Constructor
    • Accessors
      • get fix()
      • get id()
      • get link()
      • get message()
      • get problem()
      • get template()
    • Properties
      • static template
      • #fix
      • #id?
      • #link?
      • #problem
      • #template
    • Methods
      • static defineMessage()
      • static isError()
  • CommonErrors {}
    • Overview
    • Generic type variables
    • Constructor
    • Accessors
      • get errors()
    • Properties
      • static template?
      • #id?
      • #errors
    • Methods
      • delete()
      • has()
      • throw()
      • isAllowedId()
  • Error {}
    • Overview
    • Generic type variables
    • ★ Constructor
    • Accessors
      • get name()
      • get [Symbol.toStringTag]()
    • Methods
      • static define()
      • static isError()
  • Errors {}
    • Overview
    • Generic type variables
    • Constructor
    • Methods
      • get()
      • getErrors()
      • set()
    • Example usage
  • RangeError {}
    • Overview
    • Generic type variables
    • ★ Constructor
    • Accessors
      • get max()
      • get min()
      • get name()
      • get range()
      • get [Symbol.toStringTag]()
    • Properties
      • static template
      • #max?
      • #min?
    • Methods
      • static define()
      • static isRangeError()
  • RangeErrors {}
    • Overview
    • Generic type variables
    • Constructor
    • Methods
      • get()
      • getErrors()
      • set()
    • Example usage
  • TypeError {}
    • Overview
    • Generic type variables
    • ★ Constructor
    • Accessors
      • get name()
      • get type()
      • get [Symbol.toStringTag]()
    • Properties
      • static template
      • #type?
    • Methods
      • static define()
      • static isTypeError()
  • TypeErrors {}
    • Overview
    • Generic type variables
    • Constructor
    • Methods
      • get()
      • getErrors()
      • set()
  • ValidationError {}
    • Overview
    • Generic type variables
    • ★ Constructor
    • Accessors
      • get name()
      • get [Symbol.toStringTag]()
    • Methods
      • static define()
      • static isValidationError()
  • ValidationErrors {}
    • Overview
    • Generic type variables
    • Constructor
    • Methods
      • get()
      • getErrors()
      • set()
  • Change log
    • Keep a changelog
    • CHANGELOG.md
    • v3.0.0-rc
  • GIT
    • Commit
    • Semantic Versioning
  • License
    • MIT
  • Social
    • Gettr
    • Twitter
    • YouTube
  • Contact
    • ⋯ Chat
    • @ Email
    • ✆ Phone
  • Donate
    • ฿ Cryptocurrency
    • $ Fiat
Powered by GitBook
On this page
  • TypeErrors.prototype.get()
  • Generic type variables
  • Parameters
  • Return type
  • Returns
  • Example usage

Was this helpful?

  1. TypeErrors {}
  2. Methods

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

Last updated 1 year ago

Was this helpful?