Skip to content

Commit 3c9fbd3

Browse files
Merge pull request #3 from angular-package/1.0.x
1.0.2
2 parents 9a81957 + 5a2ef17 commit 3c9fbd3

File tree

4 files changed

+67
-33
lines changed

4 files changed

+67
-33
lines changed

CHANGELOG.md

+14-1
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,22 @@ All notable changes to this project will be documented in this file.
66
The format is based on [Keep a Changelog](http://keepachangelog.com/)
77
and this project adheres to [Semantic Versioning](http://semver.org/).
88

9+
## [1.0.2] - 2021-08-04
10+
11+
### 1.0.2 Update
12+
13+
- Update `README.md`.
14+
15+
### 1.0.2 Fix
16+
17+
- [`253dda9`][253dda9]
18+
Fixes the `homepage` link in the `package.json`.
19+
20+
[77f326a]: https://github.com/angular-package/error/commit/253dda9b0cd14d7766f7ac3da33e4aaf35af1193
21+
922
## [1.0.1] - 2021-08-04
1023

11-
### Fix
24+
### 1.0.1 Fix
1225

1326
- [`ab8729f`][ab8729f]
1427
Remove unnecessary peer dependencies.

README.md

+49-28
Original file line numberDiff line numberDiff line change
@@ -2,19 +2,19 @@
22

33
Useful and simple to use packages based on the [angular.io][angulario].
44

5-
| Package | Description | Status |
6-
| :----------------------------------- | :------------------------------------------------------ | -----: |
7-
| [callback][callback-github-readme] | Manages the callback [`function`][js-function]. | [![npm version][callback-npm-badge-svg]][callback-npm-badge] |
8-
| [change-detection][cd-github-readme] | Improves application performance. | [![npm version][cd-npm-badge-svg]][cd-npm-badge] |
9-
| [component-loader][cl-github-readme] | Handles dynamic loading components. | [![npm version][cl-npm-badge-svg]][cl-npm-badge] |
10-
| [core][core-github-readme] | Core features. | [![npm version][core-npm-badge-svg]][core-npm-badge] |
11-
| [error][error-github-readme] | Manages an [`Error`][js-error]. | [![npm version][error-npm-badge-svg]][error-npm-badge] |
12-
| [prism][prism-github-readme] | [`Prism`][prism-js] highlighter module. | [![npm version][prism-npm-badge-svg]][prism-npm-badge] |
13-
| [property][property-github-readme] | Handles object properties. | [![npm version][property-npm-badge-svg]][property-npm-badge] |
14-
| [reactive][reactive-github-readme] | Automatize the process of creating some rxjs features. | [![npm version][reactive-npm-badge-svg]][reactive-npm-badge] |
15-
| [testing][testing-github-readme] | Support for testing other packages. | [![npm version][testing-npm-badge-svg]][testing-npm-badge] |
16-
| [type][type-github-readme] | Common types, type guards, and type checkers. | [![npm version][type-npm-badge-svg]][type-npm-badge] |
17-
| [ui][ui-github-readme] | User interface. | *In Progress* |
5+
| Package | Description | Status |
6+
| :----------------------------------- | :----------------------------------------------------- | -----: |
7+
| [callback][callback-github-readme] | Manages the callback [`function`][js-function]. | [![npm version][callback-npm-badge-png]][callback-npm-badge] |
8+
| [change-detection][cd-github-readme] | Improves application performance. | [![npm version][cd-npm-badge-png]][cd-npm-badge] |
9+
| [component-loader][cl-github-readme] | Handles dynamic loading components. | [![npm version][cl-npm-badge-png]][cl-npm-badge] |
10+
| [core][core-github-readme] | Core features. | [![npm version][core-npm-badge-png]][core-npm-badge] |
11+
| [error][error-github-readme] | Manages an [`Error`][js-error]. | [![npm version][error-npm-badge-png]][error-npm-badge] |
12+
| [prism][prism-github-readme] | [`Prism`][prism-js] highlighter module. | [![npm version][prism-npm-badge-png]][prism-npm-badge] |
13+
| [property][property-github-readme] | Handles object properties. | [![npm version][property-npm-badge-png]][property-npm-badge] |
14+
| [reactive][reactive-github-readme] | Automatize the process of creating some rxjs features. | [![npm version][reactive-npm-badge-png]][reactive-npm-badge] |
15+
| [testing][testing-github-readme] | Support for testing other packages. | [![npm version][testing-npm-badge-png]][testing-npm-badge] |
16+
| [type][type-github-readme] | Common types, type guards, and type checkers. | [![npm version][type-npm-badge-png]][type-npm-badge] |
17+
| [ui][ui-github-readme] | User interface. | *In Progress* |
1818

1919
> Click on the package name to visit its [GitHub](https://github.com/) page.
2020
@@ -94,7 +94,7 @@ Run `ng test error` to execute the unit tests via [Karma](https://karma-runner.g
9494
Install `@angular-package/error` package with command:
9595

9696
```bash
97-
npm i --save @angular-package/error
97+
npm i @angular-package/error --save
9898
```
9999

100100
<br>
@@ -118,9 +118,9 @@ Manages an [`Error`][js-error] of the validation.
118118

119119
**Static methods:**
120120

121-
| Methods | Description |
122-
| :----------------------------------------------------------------- | :---------- |
123-
| [`ValidationError.defineMessage()`](#validationerrordefinemessage) | Defines the validation error message of a [`string`][js-string] type from the provided `message` of the [`ErrorMessage`](#errormessage) interface |
121+
| ValidationError. | Description |
122+
| :------------------------------------------------- | :---------- |
123+
| [`defineMessage()`](#validationerrordefinemessage) | Defines the validation error message of a [`string`][js-string] type from the provided `message` of the [`ErrorMessage`](#errormessage) interface |
124124

125125
**Constructor:**
126126

@@ -130,9 +130,11 @@ Manages an [`Error`][js-error] of the validation.
130130

131131
<br>
132132

133-
## `ValidationError` static properties
133+
### `ValidationError` static properties
134134

135-
### `ValidationError.template`
135+
----
136+
137+
#### `ValidationError.template`
136138

137139
Template of the error message with the replaceable `[problem]` and `[fix]`. By default, it's set to `Problem: [problem] => Fix: [fix]`.
138140

@@ -142,9 +144,11 @@ static template = `Problem: [problem] => Fix: [fix]`;
142144

143145
<br>
144146

145-
## `ValidationError` instance public properties
147+
### `ValidationError` instance public properties
146148

147-
### `ValidationError.prototype.fix`
149+
----
150+
151+
#### `ValidationError.prototype.fix`
148152

149153
A possible solution to the described problem of a [`string`][js-string] type. By default, it's an empty [`string`][js-string].
150154

@@ -154,7 +158,7 @@ public fix = '';
154158

155159
<br>
156160

157-
### `ValidationError.prototype.name`
161+
#### `ValidationError.prototype.name`
158162

159163
Error name of a [`string`][js-string] type that is being thrown. By default, it's [`ValidationError`](#validationerror).
160164

@@ -164,7 +168,7 @@ public name = ValidationError.name;
164168

165169
<br>
166170

167-
### `ValidationError.prototype.problem`
171+
#### `ValidationError.prototype.problem`
168172

169173
The validation problem of a [`string`][js-string] type. By default, it's an empty [`string`][js-string].
170174

@@ -174,9 +178,11 @@ public problem = '';
174178

175179
<br>
176180

177-
## `ValidationError` static methods
181+
### `ValidationError` static methods
182+
183+
----
178184

179-
### `ValidationError.defineMessage()`
185+
#### `ValidationError.defineMessage()`
180186

181187
Defines the validation error message of a [`string`][js-string] type from the provided `message` of the [`ErrorMessage`](#errormessage) interface.
182188

@@ -228,9 +234,11 @@ const errorMessage = ValidationError.defineMessage({ fix, problem });
228234

229235
<br>
230236

231-
## `ValidationError` constructor
237+
### `ValidationError` constructor
238+
239+
----
232240

233-
### `ValidationError()`
241+
#### `ValidationError()`
234242

235243
Creates a new instance with the message. If the provided `message` is an [`object`][js-object], then its properties are assigned to the instance.
236244

@@ -273,7 +281,9 @@ const validationError = new ValidationError({ fix, problem });
273281

274282
## Interface
275283

276-
### ErrorMessage
284+
### Common
285+
286+
#### `ErrorMessage`
277287

278288
The shape of an [`object`][js-object] for an [`error`][js-error] message that contains a possible solution to the described problem.
279289

@@ -363,6 +373,7 @@ MIT © angular-package ([license][error-license])
363373
<!-- Package: callback -->
364374
<!-- npm -->
365375
[callback-npm-badge-svg]: https://badge.fury.io/js/%40angular-package%2Fcallback.svg
376+
[callback-npm-badge-png]: https://badge.fury.io/js/%40angular-package%2Fcallback.png
366377
[callback-npm-badge]: https://badge.fury.io/js/%40angular-package%2Fcallback
367378
[callback-npm-readme]: https://www.npmjs.com/package/@angular-package/callback#readme
368379

@@ -372,6 +383,7 @@ MIT © angular-package ([license][error-license])
372383
<!-- Package: change-detection -->
373384
<!-- npm -->
374385
[cd-npm-badge-svg]: https://badge.fury.io/js/%40angular-package%2Fchange-detection.svg
386+
[cd-npm-badge-png]: https://badge.fury.io/js/%40angular-package%2Fchange-detection.png
375387
[cd-npm-badge]: https://badge.fury.io/js/%40angular-package%2Fchange-detection
376388
[cd-npm-readme]: https://www.npmjs.com/package/@angular-package/change-detection#readme
377389

@@ -381,6 +393,7 @@ MIT © angular-package ([license][error-license])
381393
<!-- Package: component-loader -->
382394
<!-- npm -->
383395
[cl-npm-badge-svg]: https://badge.fury.io/js/%40angular-package%2Fcomponent-loader.svg
396+
[cl-npm-badge-png]: https://badge.fury.io/js/%40angular-package%2Fcomponent-loader.png
384397
[cl-npm-badge]: https://badge.fury.io/js/%40angular-package%2Fcomponent-loader
385398
[cl-npm-readme]: https://www.npmjs.com/package/@angular-package/component-loader#readme
386399

@@ -390,6 +403,7 @@ MIT © angular-package ([license][error-license])
390403
<!-- Package: core -->
391404
<!-- npm -->
392405
[core-npm-badge-svg]: https://badge.fury.io/js/%40angular-package%2Fcore.svg
406+
[core-npm-badge-png]: https://badge.fury.io/js/%40angular-package%2Fcore.png
393407
[core-npm-badge]: https://badge.fury.io/js/%40angular-package%2Fcore
394408
[core-npm-readme]: https://www.npmjs.com/package/@angular-package/core#readme
395409

@@ -399,6 +413,7 @@ MIT © angular-package ([license][error-license])
399413
<!-- Package: error -->
400414
<!-- npm -->
401415
[error-npm-badge-svg]: https://badge.fury.io/js/%40angular-package%2Ferror.svg
416+
[error-npm-badge-png]: https://badge.fury.io/js/%40angular-package%2Ferror.png
402417
[error-npm-badge]: https://badge.fury.io/js/%40angular-package%2Ferror
403418
[error-npm-readme]: https://www.npmjs.com/package/@angular-package/error#readme
404419

@@ -408,6 +423,7 @@ MIT © angular-package ([license][error-license])
408423
<!-- Package: prism -->
409424
<!-- npm -->
410425
[prism-npm-badge-svg]: https://badge.fury.io/js/%40angular-package%2Fprism.svg
426+
[prism-npm-badge-png]: https://badge.fury.io/js/%40angular-package%2Fprism.png
411427
[prism-npm-badge]: https://badge.fury.io/js/%40angular-package%2Fprism
412428
[prism-npm-readme]: https://www.npmjs.com/package/@angular-package/prism#readme
413429

@@ -417,6 +433,7 @@ MIT © angular-package ([license][error-license])
417433
<!-- Package: property -->
418434
<!-- npm -->
419435
[property-npm-badge-svg]: https://badge.fury.io/js/%40angular-package%2Fproperty.svg
436+
[property-npm-badge-png]: https://badge.fury.io/js/%40angular-package%2Fproperty.png
420437
[property-npm-badge]: https://badge.fury.io/js/%40angular-package%2Fproperty
421438
[property-npm-readme]: https://www.npmjs.com/package/@angular-package/property#readme
422439

@@ -426,6 +443,7 @@ MIT © angular-package ([license][error-license])
426443
<!-- Package: reactive -->
427444
<!-- npm -->
428445
[reactive-npm-badge-svg]: https://badge.fury.io/js/%40angular-package%2Freactive.svg
446+
[reactive-npm-badge-png]: https://badge.fury.io/js/%40angular-package%2Freactive.png
429447
[reactive-npm-badge]: https://badge.fury.io/js/%40angular-package%2Freactive
430448
[reactive-npm-readme]: https://www.npmjs.com/package/@angular-package/reactive#readme
431449

@@ -435,6 +453,7 @@ MIT © angular-package ([license][error-license])
435453
<!-- Package: testing -->
436454
<!-- npm -->
437455
[testing-npm-badge-svg]: https://badge.fury.io/js/%40angular-package%2Ftesting.svg
456+
[testing-npm-badge-png]: https://badge.fury.io/js/%40angular-package%2Ftesting.png
438457
[testing-npm-badge]: https://badge.fury.io/js/%40angular-package%2Ftesting
439458
[testing-npm-readme]: https://www.npmjs.com/package/@angular-package/testing#readme
440459

@@ -444,6 +463,7 @@ MIT © angular-package ([license][error-license])
444463
<!-- Package: type -->
445464
<!-- npm -->
446465
[type-npm-badge-svg]: https://badge.fury.io/js/%40angular-package%2Ftype.svg
466+
[type-npm-badge-png]: https://badge.fury.io/js/%40angular-package%2Ftype.png
447467
[type-npm-badge]: https://badge.fury.io/js/%40angular-package%2Ftype
448468
[type-npm-readme]: https://www.npmjs.com/package/@angular-package/type#readme
449469

@@ -456,6 +476,7 @@ MIT © angular-package ([license][error-license])
456476
<!-- Package: ui -->
457477
<!-- npm -->
458478
[ui-npm-badge-svg]: https://badge.fury.io/js/%40angular-package%2Fui.svg
479+
[ui-npm-badge-svg]: https://badge.fury.io/js/%40angular-package%2Fui.svg
459480
[ui-npm-badge]: https://badge.fury.io/js/%40angular-package%2Fui
460481
[ui-npm-readme]: https://www.npmjs.com/package/@angular-package/ui#readme
461482

package-lock.json

+2-2
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
{
22
"name": "@angular-package/error",
3-
"version": "1.0.1",
3+
"version": "1.0.2",
44
"description": "Manages the callback function.",
55
"author": "Angular Package <[email protected]> (https://wvvw.dev)",
6-
"homepage": "https://github.com/angular-package/testing#readme",
6+
"homepage": "https://github.com/angular-package/error#readme",
77
"peerDependencies": {
88
"@angular-package/type": "^4.2.0"
99
},

0 commit comments

Comments
 (0)