Error
TwitterGitHub
v1.0
v1.0
  • 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
  • Error()
  • Parameters
  • Example usage

Was this helpful?

  1. Error {}

★ Constructor

The `Error` object constructor

Error()

Creates the Error instance with the message built from the given described problem and its solution, optional explicit identification on the given or stored template.

error.class.ts
constructor(
  problem: string,
  fix: string,
  id?: Id,
  template = Error.template
) {
  super(problem, fix, id, template);
}

Parameters

problem:string

Description of the problem of a string type.

fix:string

A solution to the given problem of a string type.

id?:Id

Optional unique identification to the given problem of generic type variable Id.

template:string=Error.template

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

Example usage

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

// Returns "Error: ProblemTE:201: Wrong type => Fix: Change the type".
new Error('Wrong type', 'Change the type', 'TE:201');
PreviousGeneric type variablesNextAccessors

Last updated 1 year ago

Was this helpful?