Merge pull request #8 from angular-package/2.0.x

2.0.1

Author: angularpackage

CHANGELOG.md

@@ -6,6 +6,19 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
+## [2.0.1] - 2021-08-12
+
+### 2.0.1 Fix
+
+- [`c77f3cf`][c77f3cf]  
+  Fix JS documentation of `ValidationError`.  
+
+- [`bc8e965`][bc8e965]  
+  Fix documentation of `README.md`.  
+
+[c77f3cf]: https://github.com/angular-package/error/commit/c77f3cfc8f7958dbfa29022d2e564d6095c2dc65
+[bc8e965]: https://github.com/angular-package/error/commit/bc8e9653bd5e5546f2a3df2d6d6f18bcefea192b
+
 ## [2.0.0] - 2021-08-12
 
 ### 2.0.0 Added

README.md

@@ -146,9 +146,9 @@ Manages an [`Error`][js-error] of validation.
 | ValidationError.prototype.                  | Description |
 | :------------------------------------------ | :---------- |
 | [`fix: string`][error-property-fix]         | A possible solution to the described [`problem`][error-property-problem] of validation that is guarded by a [`string`][js-string] type. |
-| [`message: string`][error-property-message] | A validation error message guarded by a [`string`][js-string] type that can be built with the [`problem`][error-property-problem] and [`fix`][error-property-fix] of [`ValidationError`](#validationerror) by the [`throw()`][error-method-throw] and [`setMessage()`][error-method-setmessage] method. |
+| [`message: string`][error-property-message] | A validation error message guarded by a [`string`][js-string] type that can be built with the [`problem`][error-property-problem] and [`fix`][error-property-fix] of [`ValidationError`](#validationerror) on the [`template`][error-property-template] by the [`throw()`][error-method-throw] and [`setMessage()`][error-method-setmessage] method. |
 | [`name: string`][error-property-name]       | Error name of a [`string`][js-string] type that is being thrown. |
-| [`problem: string`][error-property-problem] | Description of a validation problem guarded by a [`string`][js-string] type. |
+| [`problem: string`][error-property-problem] | Description of a validation [`problem`][error-property-problem] guarded by a [`string`][js-string] type. |
 
 [error-property-fix]: #validationerrorprototypefix
 [error-property-message]: #validationerrorprototypemessage
@@ -173,7 +173,7 @@ Manages an [`Error`][js-error] of validation.
 | :---------------------------------------------- | :---------- |
 | [`setFix()`][error-method-setfix]               | Sets the fix a possible solution to the described [`problem`][error-property-problem]. |
 | [`setMessage()`][error-method-setmessage]       | Sets the validation error message of a [`string`][js-string] type from the provided `message` of the [`ErrorMessage`](#errormessage) interface. |
-| [`setProblem()`][error-method-setproblem]       | Sets description problem of a [`ValidationError`](#validationerror). |
+| [`setProblem()`][error-method-setproblem]       | Sets description problem of a validation. |
 | [`setTemplate()`][error-method-settemplate]     | Sets the template of validation error message. |
 | [`throw()`][error-method-throw]                 | Throws an error of [`ValidationError`](#validationerror) with actual settings. |
 | [`updateMessage()`][error-method-updatemessage] | Updates the message with a stored [`fix`][error-property-fix], [`problem`][error-property-problem], and [`template`][error-property-template]. |
@@ -195,7 +195,7 @@ Manages an [`Error`][js-error] of validation.
 
 ![update]
 
-**`2.0.0`:** Uses static private property `#template` and guards the value with private static method `#guardTemplate()` to be `string` type that contains `[fix]` and `[problem]` words.
+**`2.0.0`:** Uses static private property `#template` and guards the value with private static method `#guardTemplate()` to be [`string`][js-string] type that contains `[fix]` and `[problem]` words.
 
 A template of the error message guarded by [`string`][js-string] type with the replaceable `[problem]` and `[fix]` words. By default, it's set to `Problem: [problem] => Fix: [fix]`. It can be set directly or by the [`setTemplate()`][error-method-settemplate] and [`setMessage()`][error-method-setmessage] method. The value is being checked against the existence of `[problem]` and `[fix]` words.
 
@@ -239,7 +239,7 @@ public set fix(value: string) {
 
 ![update]
 
-**`2.0.0`:** Uses inherited from `Error` property and guards the value to be a [`string`][js-string] type.
+**`2.0.0`:** Uses inherited from [`Error`][js-error] property and guards the value to be a [`string`][js-string] type.
 
 A validation error message guarded by a [`string`][js-string] type that can be build from the [`problem`][error-property-problem] and [`fix`][error-property-fix] of [`ValidationError`](#validationerror) on the [`template`][error-property-template]. It can be set directly or by the [`throw()`][error-method-throw] and [`setMessage()`][error-method-setmessage] method.
 
@@ -672,7 +672,7 @@ console.log(validationError.message);
 
 ![new]
 
-Sets description [`problem`][error-property-problem] of a validation error.
+Sets description [`problem`][error-property-problem] of a validation.
 
 ```typescript
 public setProblem(
@@ -690,8 +690,8 @@ public setProblem(
 
 | Name: type                                   | Description |
 | :------------------------------------------- | :---------- |
-| `fix: string`                                | A possible solution to the described [`problem`][error-property-problem] guarded by a [`string`][js-string] type. |
-| `callback?: ResultCallback<CallbackPayload>` | An optional callback function of [`ResultCallback`][package-callback-resultcallback] type to handle the check whether the provided `fix` is a [`string`][js-string]. By default, it uses an internal callback under the `'setProblem'` name, which can be initially set by the optional `callback` parameter that gives access to the internal instance of [`Callback`][callback-github-readme]. |
+| `problem: string`                            | Description of a validation [`problem`][error-property-problem] guarded by a [`string`][js-string] type. |
+| `callback?: ResultCallback<CallbackPayload>` | An optional callback function of [`ResultCallback`][package-callback-resultcallback] type to handle the check whether the provided `problem` is a [`string`][js-string]. By default, it uses an internal callback under the `'setProblem'` name, which can be initially set by the optional `callback` parameter that gives access to the internal instance of [`Callback`][callback-github-readme]. |
 
 **Returns:**
 
@@ -856,6 +856,26 @@ const validationError = new ValidationError({ fix, problem, template });
 validationError.throw();
 ```
 
+```typescript
+// Example usage.
+import { ValidationError } from '@angular-package/error';
+
+// Define a fix.
+const fix = 'There is no solution to the described problem.';
+
+// Define a problem.
+const problem = 'The problem has no solution.';
+
+// Define a template.
+const template = 'PROBLEM: [problem] FIX: [fix]';
+
+// Initialize an instance.
+const validationError = new ValidationError();
+
+// Throw an error with message.
+validationError.throw({ fix, problem, template });
+```
+
 <br>
 
 #### `ValidationError.prototype.updateMessage()`
@@ -990,14 +1010,14 @@ export interface ErrorMessage {
 **Properties:**
 
 **`fix: string`**  
-Possible solution to the described problem of a [`string`][js-string] type.
+A possible solution to the described problem of a [`string`][js-string] type.
 
 **`problem: string`**  
 Description of validation problem of a [`string`][js-string] type.
 
 **`template?: string`**  
 ![new]  
-An optional message template of a [`string`][js-string] type.
+An optional error message template of a [`string`][js-string] type.
 
 <br>
 

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@angular-package/error",
-  "version": "2.0.0",
+  "version": "2.0.1",
   "description": "Manages an error.",
   "author": "Angular Package <angular-package@wvvw.dev> (https://wvvw.dev)",
   "homepage": "https://github.com/angular-package/error#readme",
@@ -22,8 +22,13 @@
     "@angular",
     "@angular-package",
     "@angular-package/error",
+    "Error",
     "angular-package",
-    "Error"
+    "error fix",
+    "error message",
+    "error problem",
+    "error template",
+    "validation error"
   ],
   "repository": {
     "type": "git",

package.json

@@ -51,8 +51,8 @@ export class ValidationError extends Error {
 
   /**
    * A template of the error message guarded by a `string` type with the replaceable `[problem]` and `[fix]` words.
+   * By default, it's set to `Problem: [problem] => Fix: [fix]`. It can be set directly or by the `setTemplate()` and `setMessage()` method.
    * The value is being checked against the existence of `[problem]` and `[fix]` words.
-   * By default, it's set to `Problem: [problem] => Fix: [fix]`.
    */
   static get template(): string {
     return ValidationError.#template;
@@ -66,7 +66,7 @@ export class ValidationError extends Error {
   //#region instance public properties.
   /**
    * A possible solution to the described `problem` of validation that is guarded by a `string` type.
-   * By default, it's an empty `string`.
+   * By default, it's an empty `string`. It can be set directly or by the `setTemplate()` and `setMessage()` method
    */
   public get fix(): string {
     return this.#fix;
@@ -76,8 +76,8 @@ export class ValidationError extends Error {
   }
 
   /**
-   * A validation error message guarded by a `string` type that can be built with the `problem` and `fix` of `ValidationError` by the
-   * `throw()` and `setMessage()` method.
+   * A validation error message guarded by a `string` type that can be built from the `problem` and `fix` of `ValidationError` on the
+   * `template`. It can be set directly or by the `throw()` or `setMessage()` method.
    */
   public set message(value: string) {
     super.message = guard.string(value) ? value : super.message;
@@ -87,14 +87,13 @@ export class ValidationError extends Error {
   }
 
   /**
-   * Error name of a `string` type that is being thrown.
-   * By default, it's `ValidationError`.
+   * Error name of a `string` type that is being thrown. By default, it's `ValidationError`.
    */
   public name = ValidationError.name;
 
   /**
-   * Description of a validation problem guarded by a `string` type.
-   * By default, it's an empty `string`.
+   * Description of a validation problem guarded by a `string` type. By default, it's an empty `string`.
+   * It can be set directly or by the `setProblem()` and `setMessage()` method.
    */
   public get problem(): string {
     return this.#problem;
@@ -107,7 +106,7 @@ export class ValidationError extends Error {
   //#region static public methods
   /**
    * Defines the validation error message of a `string` type from the provided `message` of the `ErrorMessage` interface.
-   * @param message An object of an `ErrorMessage` interface to build the message of a `string` type. The value is checked against
+   * @param message An object of an `ErrorMessage` interface to build a message of a `string` type. The value is checked against
    * the proper `object`.
    * @param callback An optional callback function of `ResultCallback` type to handle the check whether the provided message contains
    * required `problem` and `fix` properties.
@@ -171,7 +170,7 @@ export class ValidationError extends Error {
   /**
    * Creates a new instance with the message. If the provided `message` is an `object`, then its properties are assigned
    * to the instance.
-   * @param message The message of a `string` type or of an `ErrorMessage` interface to throw with an `Error`.
+   * @param message The message of a `string` type or of an `ErrorMessage` interface that is used to throw with an `Error`.
    * @param callback An optional function to handle the internal instance of `Callback`.
    * @angularpackage
    */
@@ -246,8 +245,8 @@ export class ValidationError extends Error {
   }
 
   /**
-   * Sets description problem of a validation error.
-   * @param problem Description of a problem of validation error guarded by a `string` type.
+   * Sets description problem of a validation.
+   * @param problem Description of validation problem guarded by a `string` type.
    * @param callback An optional callback function of `ResultCallback` type to handle the check whether the provided `problem` is a
    * `string`. By default, it uses an internal callback under the `'setProblem'` name, which can be initially set by the optional `callback`
    * parameter that gives access to the internal instance of `Callback`.
@@ -287,7 +286,8 @@ export class ValidationError extends Error {
   /**
    * Throws an error of `ValidationError` with the message built from the stored `fix`, `problem` and `template` or optionally from
    * the provided `message`.
-   * @param message An optional
+   * @param message An optional object of an `ErrorMessage` interface to build the message of a `string` type.
+   * The value is checked against the proper object.
    * @angularpackage
    */
   public throw(message?: string | ErrorMessage): void {