2
2
3
3
Useful and simple to use packages based on the [ angular.io] [ angulario ] .
4
4
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* |
18
18
19
19
> Click on the package name to visit its [ GitHub] ( https://github.com/ ) page.
20
20
@@ -94,7 +94,7 @@ Run `ng test error` to execute the unit tests via [Karma](https://karma-runner.g
94
94
Install ` @angular-package/error ` package with command:
95
95
96
96
``` bash
97
- npm i --save @angular-package/error
97
+ npm i @angular-package/error --save
98
98
```
99
99
100
100
<br >
@@ -118,9 +118,9 @@ Manages an [`Error`][js-error] of the validation.
118
118
119
119
** Static methods:**
120
120
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 |
124
124
125
125
** Constructor:**
126
126
@@ -130,9 +130,11 @@ Manages an [`Error`][js-error] of the validation.
130
130
131
131
<br >
132
132
133
- ## ` ValidationError ` static properties
133
+ ### ` ValidationError ` static properties
134
134
135
- ### ` ValidationError.template `
135
+ ----
136
+
137
+ #### ` ValidationError.template `
136
138
137
139
Template of the error message with the replaceable ` [problem] ` and ` [fix] ` . By default, it's set to ` Problem: [problem] => Fix: [fix] ` .
138
140
@@ -142,9 +144,11 @@ static template = `Problem: [problem] => Fix: [fix]`;
142
144
143
145
<br >
144
146
145
- ## ` ValidationError ` instance public properties
147
+ ### ` ValidationError ` instance public properties
146
148
147
- ### ` ValidationError.prototype.fix `
149
+ ----
150
+
151
+ #### ` ValidationError.prototype.fix `
148
152
149
153
A possible solution to the described problem of a [ ` string ` ] [ js-string ] type. By default, it's an empty [ ` string ` ] [ js-string ] .
150
154
@@ -154,7 +158,7 @@ public fix = '';
154
158
155
159
<br >
156
160
157
- ### ` ValidationError.prototype.name `
161
+ #### ` ValidationError.prototype.name `
158
162
159
163
Error name of a [ ` string ` ] [ js-string ] type that is being thrown. By default, it's [ ` ValidationError ` ] ( #validationerror ) .
160
164
@@ -164,7 +168,7 @@ public name = ValidationError.name;
164
168
165
169
<br >
166
170
167
- ### ` ValidationError.prototype.problem `
171
+ #### ` ValidationError.prototype.problem `
168
172
169
173
The validation problem of a [ ` string ` ] [ js-string ] type. By default, it's an empty [ ` string ` ] [ js-string ] .
170
174
@@ -174,9 +178,11 @@ public problem = '';
174
178
175
179
<br >
176
180
177
- ## ` ValidationError ` static methods
181
+ ### ` ValidationError ` static methods
182
+
183
+ ----
178
184
179
- ### ` ValidationError.defineMessage() `
185
+ #### ` ValidationError.defineMessage() `
180
186
181
187
Defines the validation error message of a [ ` string ` ] [ js-string ] type from the provided ` message ` of the [ ` ErrorMessage ` ] ( #errormessage ) interface.
182
188
@@ -228,9 +234,11 @@ const errorMessage = ValidationError.defineMessage({ fix, problem });
228
234
229
235
<br >
230
236
231
- ## ` ValidationError ` constructor
237
+ ### ` ValidationError ` constructor
238
+
239
+ ----
232
240
233
- ### ` ValidationError() `
241
+ #### ` ValidationError() `
234
242
235
243
Creates a new instance with the message. If the provided ` message ` is an [ ` object ` ] [ js-object ] , then its properties are assigned to the instance.
236
244
@@ -273,7 +281,9 @@ const validationError = new ValidationError({ fix, problem });
273
281
274
282
## Interface
275
283
276
- ### ErrorMessage
284
+ ### Common
285
+
286
+ #### ` ErrorMessage `
277
287
278
288
The shape of an [ ` object ` ] [ js-object ] for an [ ` error ` ] [ js-error ] message that contains a possible solution to the described problem.
279
289
@@ -363,6 +373,7 @@ MIT © angular-package ([license][error-license])
363
373
<!-- Package: callback -->
364
374
<!-- npm -->
365
375
[ 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
366
377
[ callback-npm-badge ] : https://badge.fury.io/js/%40angular-package%2Fcallback
367
378
[ callback-npm-readme ] : https://www.npmjs.com/package/@angular-package/callback#readme
368
379
@@ -372,6 +383,7 @@ MIT © angular-package ([license][error-license])
372
383
<!-- Package: change-detection -->
373
384
<!-- npm -->
374
385
[ 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
375
387
[ cd-npm-badge ] : https://badge.fury.io/js/%40angular-package%2Fchange-detection
376
388
[ cd-npm-readme ] : https://www.npmjs.com/package/@angular-package/change-detection#readme
377
389
@@ -381,6 +393,7 @@ MIT © angular-package ([license][error-license])
381
393
<!-- Package: component-loader -->
382
394
<!-- npm -->
383
395
[ 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
384
397
[ cl-npm-badge ] : https://badge.fury.io/js/%40angular-package%2Fcomponent-loader
385
398
[ cl-npm-readme ] : https://www.npmjs.com/package/@angular-package/component-loader#readme
386
399
@@ -390,6 +403,7 @@ MIT © angular-package ([license][error-license])
390
403
<!-- Package: core -->
391
404
<!-- npm -->
392
405
[ 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
393
407
[ core-npm-badge ] : https://badge.fury.io/js/%40angular-package%2Fcore
394
408
[ core-npm-readme ] : https://www.npmjs.com/package/@angular-package/core#readme
395
409
@@ -399,6 +413,7 @@ MIT © angular-package ([license][error-license])
399
413
<!-- Package: error -->
400
414
<!-- npm -->
401
415
[ 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
402
417
[ error-npm-badge ] : https://badge.fury.io/js/%40angular-package%2Ferror
403
418
[ error-npm-readme ] : https://www.npmjs.com/package/@angular-package/error#readme
404
419
@@ -408,6 +423,7 @@ MIT © angular-package ([license][error-license])
408
423
<!-- Package: prism -->
409
424
<!-- npm -->
410
425
[ 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
411
427
[ prism-npm-badge ] : https://badge.fury.io/js/%40angular-package%2Fprism
412
428
[ prism-npm-readme ] : https://www.npmjs.com/package/@angular-package/prism#readme
413
429
@@ -417,6 +433,7 @@ MIT © angular-package ([license][error-license])
417
433
<!-- Package: property -->
418
434
<!-- npm -->
419
435
[ 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
420
437
[ property-npm-badge ] : https://badge.fury.io/js/%40angular-package%2Fproperty
421
438
[ property-npm-readme ] : https://www.npmjs.com/package/@angular-package/property#readme
422
439
@@ -426,6 +443,7 @@ MIT © angular-package ([license][error-license])
426
443
<!-- Package: reactive -->
427
444
<!-- npm -->
428
445
[ 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
429
447
[ reactive-npm-badge ] : https://badge.fury.io/js/%40angular-package%2Freactive
430
448
[ reactive-npm-readme ] : https://www.npmjs.com/package/@angular-package/reactive#readme
431
449
@@ -435,6 +453,7 @@ MIT © angular-package ([license][error-license])
435
453
<!-- Package: testing -->
436
454
<!-- npm -->
437
455
[ 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
438
457
[ testing-npm-badge ] : https://badge.fury.io/js/%40angular-package%2Ftesting
439
458
[ testing-npm-readme ] : https://www.npmjs.com/package/@angular-package/testing#readme
440
459
@@ -444,6 +463,7 @@ MIT © angular-package ([license][error-license])
444
463
<!-- Package: type -->
445
464
<!-- npm -->
446
465
[ 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
447
467
[ type-npm-badge ] : https://badge.fury.io/js/%40angular-package%2Ftype
448
468
[ type-npm-readme ] : https://www.npmjs.com/package/@angular-package/type#readme
449
469
@@ -456,6 +476,7 @@ MIT © angular-package ([license][error-license])
456
476
<!-- Package: ui -->
457
477
<!-- npm -->
458
478
[ 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
459
480
[ ui-npm-badge ] : https://badge.fury.io/js/%40angular-package%2Fui
460
481
[ ui-npm-readme ] : https://www.npmjs.com/package/@angular-package/ui#readme
461
482
0 commit comments