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

491 lines (402 loc) 17.4 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 injectable"> <div class="content-data"> <ol class="breadcrumb"> <li class="breadcrumb-item">Injectables</li> <li class="breadcrumb-item" >ErrorCaptureDialogService</li> </ol> <ul class="nav nav-tabs" role="tablist"> <li class="nav-item"> <a href="#info" class="nav-link" 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> </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-capture-dialog.service.ts</code> </p> <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">Protected</span> <span class="modifier">Readonly</span> <a href="#applicationRef" >applicationRef</a> </li> <li> <span class="modifier">Protected</span> <span class="modifier">Readonly</span> <a href="#document" >document</a> </li> </ul> </td> </tr> <tr> <td class="col-md-4"> <h6><b>Methods</b></h6> </td> </tr> <tr> <td class="col-md-4"> <ul class="index-list"> <li> <a href="#open" >open</a> </li> </ul> </td> </tr> </tbody> </table> </section> <section data-compodoc="block-methods"> <h3 id="methods"> Methods </h3> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <a name="open"></a> <span class="name"> <span ><b>open</b></span> <a href="#open"><span class="icon ion-ios-link"></span></a> </span> </td> </tr> <tr> <td class="col-md-4"> <code>open(component: <a href="../interfaces/IErrorDialogComponent.html" target="_self">ComponentType&lt;IErrorDialogComponent&gt;</a>, errorList: WritableSignal<Error[]>)</code> </td> </tr> <tr> <td class="col-md-4"> <div class="io-line">Defined in <a href="" data-line="36" class="link-to-prism">src/lib/error-capture-dialog.service.ts:36</a></div> </td> </tr> <tr> <td class="col-md-4"> <div class="io-description"> <b>Parameters :</b> <table class="params"> <thead> <tr> <td>Name</td> <td>Type</td> <td>Optional</td> </tr> </thead> <tbody> <tr> <td>component</td> <td> <code><a href="../interfaces/IErrorDialogComponent.html" target="_self" >ComponentType&lt;IErrorDialogComponent&gt;</a></code> </td> <td> No </td> </tr> <tr> <td>errorList</td> <td> <code>WritableSignal&lt;Error[]&gt;</code> </td> <td> No </td> </tr> </tbody> </table> </div> <div class="io-description"> <b>Returns : </b> <code>Observable&lt;void&gt;</code> </div> <div class="io-description"> </div> </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="applicationRef"></a> <span class="name"> <span class="modifier">Protected</span> <span class="modifier">Readonly</span> <span ><b>applicationRef</b></span> <a href="#applicationRef"><span class="icon ion-ios-link"></span></a> </span> </td> </tr> <tr> <td class="col-md-4"> <i>Default value : </i><code>inject(ApplicationRef)</code> </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-capture-dialog.service.ts:33</a></div> </td> </tr> </tbody> </table> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <a name="document"></a> <span class="name"> <span class="modifier">Protected</span> <span class="modifier">Readonly</span> <span ><b>document</b></span> <a href="#document"><span class="icon ion-ios-link"></span></a> </span> </td> </tr> <tr> <td class="col-md-4"> <i>Default value : </i><code>inject(DOCUMENT)</code> </td> </tr> <tr> <td class="col-md-4"> <div class="io-line">Defined in <a href="" data-line="34" class="link-to-prism">src/lib/error-capture-dialog.service.ts:34</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 { ComponentType } from &#x27;@angular/cdk/overlay&#x27;; import { DOCUMENT } from &#x27;@angular/common&#x27;; import { ApplicationRef, createComponent, inject, Injectable, Injector, WritableSignal, } from &#x27;@angular/core&#x27;; import { finalize, Observable, take, } from &#x27;rxjs&#x27;; import { tap } from &#x27;rxjs/operators&#x27;; import { ErrorDialogComponent, IErrorDialogComponent, } from &#x27;./error-dialog/error-dialog.component&#x27;; import { RXAP_ERROR_DIALOG_COMPONENT, RXAP_ERROR_DIALOG_DATA, } from &#x27;./tokens&#x27;; export interface IErrorCaptureDialogService&lt;Error &#x3D; any&gt; { open(component: ComponentType&lt;IErrorDialogComponent&gt;, errorList: WritableSignal&lt;Error[]&gt;): Observable&lt;void&gt;; } @Injectable({ providedIn: &#x27;root&#x27; }) export class ErrorCaptureDialogService&lt;Error &#x3D; any&gt; implements IErrorCaptureDialogService&lt;Error&gt; { protected readonly applicationRef &#x3D; inject(ApplicationRef); protected readonly document &#x3D; inject(DOCUMENT); open(component: ComponentType&lt;IErrorDialogComponent&gt;, errorList: WritableSignal&lt;Error[]&gt;): Observable&lt;void&gt; { const body &#x3D; this.document.getElementsByTagName(&#x27;body&#x27;)[0]; const div &#x3D; this.document.createElement(&#x27;div&#x27;); body.appendChild(div); const componentRef &#x3D; createComponent(ErrorDialogComponent, { hostElement: div, environmentInjector: this.applicationRef.injector, elementInjector: Injector.create({ providers: [ { provide: RXAP_ERROR_DIALOG_DATA, useValue: errorList, }, { provide: RXAP_ERROR_DIALOG_COMPONENT, useValue: component, }, ], }), }); this.applicationRef.attachView(componentRef.hostView); return new Observable&lt;void&gt;(subscriber &#x3D;&gt; { const subscription &#x3D; componentRef.instance.closeDialog.pipe( take(1), tap(() &#x3D;&gt; { subscriber.next(); subscriber.complete(); }), finalize(() &#x3D;&gt; { componentRef.destroy(); body.removeChild(div); div.remove(); }) ).subscribe(); return () &#x3D;&gt; { subscription.unsubscribe(); }; }); } } </code></pre> </div> </div> </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 = 'injectable'; var COMPODOC_CURRENT_PAGE_URL = 'ErrorCaptureDialogService.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>