UNPKG

@rxap/ngx-error

Version:

This package provides a comprehensive error handling solution for Angular applications, including interceptors, services, and UI components to display different types of errors in a user-friendly dialog. It supports handling of generic errors, HTTP errors

563 lines (447 loc) 21.1 kB
<!doctype html> <html class="no-js" lang=""> <head> <meta charset="utf-8"> <meta http-equiv="x-ua-compatible" content="ie=edge"> <title>angular-error</title> <meta name="description" content=""> <meta name="viewport" content="width=device-width, initial-scale=1"> <link rel="icon" type="image/x-icon" href="../images/favicon.ico"> <link rel="stylesheet" href="../styles/style.css"> <link rel="stylesheet" href="../styles/dark.css"> </head> <body> <script> // Blocking script to avoid flickering dark mode // Dark mode toggle button var useDark = window.matchMedia('(prefers-color-scheme: dark)'); var darkModeState = useDark.matches; var $darkModeToggleSwitchers = document.querySelectorAll('.dark-mode-switch input'); var $darkModeToggles = document.querySelectorAll('.dark-mode-switch'); var darkModeStateLocal = localStorage.getItem('compodoc_darkmode-state'); function checkToggle(check) { for (var i = 0; i < $darkModeToggleSwitchers.length; i++) { $darkModeToggleSwitchers[i].checked = check; } } function toggleDarkMode(state) { if (window.localStorage) { localStorage.setItem('compodoc_darkmode-state', state); } checkToggle(state); const hasClass = document.body.classList.contains('dark'); if (state) { for (var i = 0; i < $darkModeToggles.length; i++) { $darkModeToggles[i].classList.add('dark'); } if (!hasClass) { document.body.classList.add('dark'); } } else { for (var i = 0; i < $darkModeToggles.length; i++) { $darkModeToggles[i].classList.remove('dark'); } if (hasClass) { document.body.classList.remove('dark'); } } } useDark.addEventListener('change', function (evt) { toggleDarkMode(evt.matches); }); if (darkModeStateLocal) { darkModeState = darkModeStateLocal === 'true'; } toggleDarkMode(darkModeState); </script> <div class="navbar navbar-default navbar-fixed-top d-md-none p-0"> <div class="d-flex"> <a href="../" class="navbar-brand">angular-error</a> <button type="button" class="btn btn-default btn-menu ion-ios-menu" id="btn-menu"></button> </div> </div> <div class="xs-menu menu" id="mobile-menu"> <div id="book-search-input" role="search"><input type="text" placeholder="Type to search"></div> <compodoc-menu></compodoc-menu> </div> <div class="container-fluid main"> <div class="row main"> <div class="d-none d-md-block menu"> <compodoc-menu mode="normal"></compodoc-menu> </div> <!-- START CONTENT --> <div class="content component"> <div class="content-data"> <ol class="breadcrumb"> <li class="breadcrumb-item">Components</li> <li class="breadcrumb-item" > AngularErrorComponent</li> </ol> <ul class="nav nav-tabs" role="tablist"> <li class="nav-item"> <a href="#info" class="nav-link active" role="tab" id="info-tab" data-bs-toggle="tab" data-link="info">Info</a> </li> <li class="nav-item"> <a href="#source" class="nav-link" role="tab" id="source-tab" data-bs-toggle="tab" data-link="source">Source</a> </li> <li class="nav-item"> <a href="#templateData" class="nav-link" role="tab" id="templateData-tab" data-bs-toggle="tab" data-link="template">Template</a> </li> <li class="nav-item"> <a href="#styleData" class="nav-link" role="tab" id="styleData-tab" data-bs-toggle="tab" data-link="style">Styles</a> </li> <li class="nav-item"> <a href="#tree" class="nav-link" role="tab" id="tree-tab" data-bs-toggle="tab" data-link="dom-tree">DOM Tree</a> </li> </ul> <div class="tab-content"> <div class="tab-pane fade active in" id="info"><p class="comment"> <h3>File</h3> </p> <p class="comment"> <code>src/lib/error/angular-error.component.ts</code> </p> <p class="comment"> <h3>Implements</h3> </p> <p class="comment"> <code><a href="../interfaces/IErrorDialogComponent.html" target="_self" >IErrorDialogComponent</a></code> </p> <section data-compodoc="block-metadata"> <h3>Metadata</h3> <table class="table table-sm table-hover metadata"> <tbody> <tr> <td class="col-md-3">selector</td> <td class="col-md-9"><code>rxap-angular-error</code></td> </tr> <tr> <td class="col-md-3">imports</td> <td class="col-md-9"> <code>DataGridModule</code> <code>KeyValuePipe</code> <code>NgForOf</code> <code>NgIf</code> </td> </tr> <tr> <td class="col-md-3">styleUrls</td> <td class="col-md-9"><code>./angular-error.component.scss</code></td> </tr> <tr> <td class="col-md-3">templateUrl</td> <td class="col-md-9"><code>./angular-error.component.html</code></td> </tr> </tbody> </table> </section> <section data-compodoc="block-index"> <h3 id="index">Index</h3> <table class="table table-sm table-bordered index-table"> <tbody> <tr> <td class="col-md-4"> <h6><b>Properties</b></h6> </td> </tr> <tr> <td class="col-md-4"> <ul class="index-list"> <li> <span class="modifier">Public</span> <span class="modifier">Readonly</span> <a href="#error" >error</a> </li> </ul> </td> </tr> <tr> <td class="col-md-4"> <h6><b>Accessors</b></h6> </td> </tr> <tr> <td class="col-md-4"> <ul class="index-list"> <li> <a href="#hasTags" >hasTags</a> </li> <li> <a href="#hasContexts" >hasContexts</a> </li> <li> <a href="#hasExtra" >hasExtra</a> </li> </ul> </td> </tr> </tbody> </table> </section> <section data-compodoc="block-properties"> <h3 id="inputs"> Properties </h3> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <a name="error"></a> <span class="name"> <span class="modifier">Public</span> <span class="modifier">Readonly</span> <span ><b>error</b></span> <a href="#error"><span class="icon ion-ios-link"></span></a> </span> </td> </tr> <tr> <td class="col-md-4"> <i>Type : </i> <code><a href="../interfaces/AngularErrorDialogData.html" target="_self" >AngularErrorDialogData</a></code> </td> </tr> <tr> <td class="col-md-4"> <i>Default value : </i><code>inject(RXAP_ERROR_DIALOG_ERROR)</code> </td> </tr> <tr> <td class="col-md-4"> <div class="io-line">Defined in <a href="" data-line="23" class="link-to-prism">src/lib/error/angular-error.component.ts:23</a></div> </td> </tr> </tbody> </table> </section> <section data-compodoc="block-accessors"> <h3 id="accessors"> Accessors </h3> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <a name="hasTags"></a> <span class="name"><b>hasTags</b><a href="#hasTags"><span class="icon ion-ios-link"></span></a></span> </td> </tr> <tr> <td class="col-md-4"> <span class="accessor"><b>get</b><code>hasTags()</code></span> </td> </tr> <tr> <td class="col-md-4"> <div class="io-line">Defined in <a href="" data-line="25" class="link-to-prism">src/lib/error/angular-error.component.ts:25</a></div> </td> </tr> </tbody> </table> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <a name="hasContexts"></a> <span class="name"><b>hasContexts</b><a href="#hasContexts"><span class="icon ion-ios-link"></span></a></span> </td> </tr> <tr> <td class="col-md-4"> <span class="accessor"><b>get</b><code>hasContexts()</code></span> </td> </tr> <tr> <td class="col-md-4"> <div class="io-line">Defined in <a href="" data-line="29" class="link-to-prism">src/lib/error/angular-error.component.ts:29</a></div> </td> </tr> </tbody> </table> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <a name="hasExtra"></a> <span class="name"><b>hasExtra</b><a href="#hasExtra"><span class="icon ion-ios-link"></span></a></span> </td> </tr> <tr> <td class="col-md-4"> <span class="accessor"><b>get</b><code>hasExtra()</code></span> </td> </tr> <tr> <td class="col-md-4"> <div class="io-line">Defined in <a href="" data-line="33" class="link-to-prism">src/lib/error/angular-error.component.ts:33</a></div> </td> </tr> </tbody> </table> </section> </div> <div class="tab-pane fade tab-source-code" id="source"> <pre class="line-numbers compodoc-sourcecode"><code class="language-typescript">import { KeyValuePipe, NgForOf, NgIf, } from &#x27;@angular/common&#x27;; import { Component, inject, } from &#x27;@angular/core&#x27;; import { DataGridModule } from &#x27;@rxap/data-grid&#x27;; import { IErrorDialogComponent } from &#x27;../error-dialog/error-dialog.component&#x27;; import { RXAP_ERROR_DIALOG_ERROR } from &#x27;../tokens&#x27;; import { AngularErrorDialogData } from &#x27;./angular-error-dialog-data&#x27;; @Component({ selector: &#x27;rxap-angular-error&#x27;, imports: [DataGridModule, KeyValuePipe, NgForOf, NgIf], templateUrl: &#x27;./angular-error.component.html&#x27;, styleUrls: [&#x27;./angular-error.component.scss&#x27;] }) export class AngularErrorComponent implements IErrorDialogComponent&lt;AngularErrorDialogData&gt; { public readonly error: AngularErrorDialogData &#x3D; inject(RXAP_ERROR_DIALOG_ERROR); public get hasTags(): boolean { return Object.keys(this.error.tags).length &gt; 0; } public get hasContexts(): boolean { return Object.keys(this.error.contexts).length &gt; 0; } public get hasExtra(): boolean { return Object.keys(this.error.extra).length &gt; 0; } } </code></pre> </div> <div class="tab-pane fade " id="templateData"> <pre class="line-numbers"><code class="language-html">&lt;rxap-data-grid [data]&#x3D;&quot;error&quot;&gt; &lt;ng-container *ngIf&#x3D;&quot;error.name&quot; rxapDataGridRowDef&#x3D;&quot;name&quot;&gt;&lt;/ng-container&gt; &lt;ng-container rxapDataGridRowDef&#x3D;&quot;message&quot;&gt;&lt;/ng-container&gt; &lt;ng-container *ngIf&#x3D;&quot;hasExtra || hasTags || hasContexts || error.stack&quot; rxapDataGridRowDef&gt; &lt;th *rxapDataGridHeaderCellDef&gt; &lt;span i18n&gt;Details&lt;/span&gt; &lt;/th&gt; &lt;/ng-container&gt; &lt;ng-container *ngIf&#x3D;&quot;error.stack&quot; rxapDataGridRowDef&#x3D;&quot;stack&quot;&gt; &lt;td *rxapDataGridCellDef&#x3D;&quot;let value&quot;&gt; &lt;pre&gt;{{ value }}&lt;/pre&gt; &lt;/td&gt; &lt;/ng-container&gt; &lt;ng-container *ngIf&#x3D;&quot;hasTags&quot; rxapDataGridRowDef&#x3D;&quot;tags&quot;&gt; &lt;td *rxapDataGridCellDef&#x3D;&quot;let value&quot;&gt; &lt;rxap-data-grid [data]&#x3D;&quot;value&quot; auto&gt;&lt;/rxap-data-grid&gt; &lt;/td&gt; &lt;/ng-container&gt; &lt;ng-container *ngIf&#x3D;&quot;hasExtra&quot; rxapDataGridRowDef&#x3D;&quot;extra&quot;&gt; &lt;td *rxapDataGridCellDef&#x3D;&quot;let value&quot;&gt; &lt;rxap-data-grid [data]&#x3D;&quot;value&quot; auto&gt;&lt;/rxap-data-grid&gt; &lt;/td&gt; &lt;/ng-container&gt; &lt;ng-container *ngIf&#x3D;&quot;hasContexts&quot; rxapDataGridRowDef&#x3D;&quot;contexts&quot;&gt; &lt;td *rxapDataGridCellDef&#x3D;&quot;let value&quot;&gt; &lt;rxap-data-grid [data]&#x3D;&quot;value&quot; auto&gt;&lt;/rxap-data-grid&gt; &lt;/td&gt; &lt;/ng-container&gt; &lt;/rxap-data-grid&gt; </code></pre> </div> <div class="tab-pane fade " id="styleData"> <p class="comment"> <code>./angular-error.component.scss</code> </p> <pre class="line-numbers"><code class="language-scss"></code></pre> </div> <div class="tab-pane fade " id="tree"> <div id="tree-container"></div> <div class="tree-legend"> <div class="title"> <b>Legend</b> </div> <div> <div class="color htmlelement"></div><span>Html element</span> </div> <div> <div class="color component"></div><span>Component</span> </div> <div> <div class="color directive"></div><span>Html element with directive</span> </div> </div> </div> </div> <script src="../js/libs/vis.min.js"></script> <script src="../js/libs/htmlparser.js"></script> <script src="../js/libs/deep-iterator.js"></script> <script> var COMPONENT_TEMPLATE = '<div><rxap-data-grid [data]="error"> <ng-container *ngIf="error.name" rxapDataGridRowDef="name"></ng-container> <ng-container rxapDataGridRowDef="message"></ng-container> <ng-container *ngIf="hasExtra || hasTags || hasContexts || error.stack" rxapDataGridRowDef> <th *rxapDataGridHeaderCellDef> <span i18n>Details</span> </th> </ng-container> <ng-container *ngIf="error.stack" rxapDataGridRowDef="stack"> <td *rxapDataGridCellDef="let value"> <pre>{{ value }}</pre> </td> </ng-container> <ng-container *ngIf="hasTags" rxapDataGridRowDef="tags"> <td *rxapDataGridCellDef="let value"> <rxap-data-grid [data]="value" auto></rxap-data-grid> </td> </ng-container> <ng-container *ngIf="hasExtra" rxapDataGridRowDef="extra"> <td *rxapDataGridCellDef="let value"> <rxap-data-grid [data]="value" auto></rxap-data-grid> </td> </ng-container> <ng-container *ngIf="hasContexts" rxapDataGridRowDef="contexts"> <td *rxapDataGridCellDef="let value"> <rxap-data-grid [data]="value" auto></rxap-data-grid> </td> </ng-container></rxap-data-grid></div>' var COMPONENTS = [{'name': 'AngularErrorComponent', 'selector': 'rxap-angular-error'},{'name': 'AnyHttpErrorComponent', 'selector': 'rxap-any-http-error'},{'name': 'CodeHttpErrorComponent', 'selector': 'rxap-http-error-message'},{'name': 'ErrorDialogComponent', 'selector': 'rxap-error-dialog'},{'name': 'MessageHttpErrorComponent', 'selector': 'rxap-http-error-message'},{'name': 'OpenApiHttpResponseErrorComponent', 'selector': 'rxap-open-api-http-response-error'}]; var DIRECTIVES = []; var ACTUAL_COMPONENT = {'name': 'AngularErrorComponent'}; </script> <script src="../js/tree.js"></script> </div><div class="search-results"> <div class="has-results"> <h1 class="search-results-title"><span class='search-results-count'></span> results matching "<span class='search-query'></span>"</h1> <ul class="search-results-list"></ul> </div> <div class="no-results"> <h1 class="search-results-title">No results matching "<span class='search-query'></span>"</h1> </div> </div> </div> <!-- END CONTENT --> </div> </div> <label class="dark-mode-switch"> <input type="checkbox"> <span class="slider"> <svg class="slider-icon" viewBox="0 0 24 24" fill="none" height="20" stroke="#000" stroke-linecap="round" stroke-linejoin="round" stroke-width="2" width="20" xmlns="http://www.w3.org/2000/svg"> <path d="M21 12.79A9 9 0 1111.21 3 7 7 0 0021 12.79z"></path> </svg> </span> </label> <script> var COMPODOC_CURRENT_PAGE_DEPTH = 1; var COMPODOC_CURRENT_PAGE_CONTEXT = 'component'; var COMPODOC_CURRENT_PAGE_URL = 'AngularErrorComponent.html'; var MAX_SEARCH_RESULTS = 15; </script> <script> $darkModeToggleSwitchers = document.querySelectorAll('.dark-mode-switch input'); checkToggle(darkModeState); if ($darkModeToggleSwitchers.length > 0) { for (var i = 0; i < $darkModeToggleSwitchers.length; i++) { $darkModeToggleSwitchers[i].addEventListener('change', function (event) { darkModeState = !darkModeState; toggleDarkMode(darkModeState); }); } } </script> <script src="../js/libs/custom-elements.min.js"></script> <script src="../js/libs/lit-html.js"></script> <script src="../js/menu-wc.js" defer></script> <script nomodule src="../js/menu-wc_es5.js" defer></script> <script src="../js/libs/bootstrap-native.js"></script> <script src="../js/libs/es6-shim.min.js"></script> <script src="../js/libs/EventDispatcher.js"></script> <script src="../js/libs/promise.min.js"></script> <script src="../js/libs/zepto.min.js"></script> <script src="../js/compodoc.js"></script> <script src="../js/tabs.js"></script> <script src="../js/menu.js"></script> <script src="../js/libs/clipboard.min.js"></script> <script src="../js/libs/prism.js"></script> <script src="../js/sourceCode.js"></script> <script src="../js/search/search.js"></script> <script src="../js/search/lunr.min.js"></script> <script src="../js/search/search-lunr.js"></script> <script src="../js/search/search_index.js"></script> <script src="../js/lazy-load-graphs.js"></script> </body> </html>