grassrootseconomics/cic-staff-client
5
0
Fork 0
Code Issues 26 Pull Requests Projects Releases Wiki Activity
master
cic-staff-client/docs/compodoc/injectables/LoggingService.html

889 lines
33 KiB
HTML
Raw Permalink Normal View History

Add docs.
2021-05-10 20:56:20 +02:00
<!doctype html>
<html class="no-js" lang="">
<head>
<meta charset="utf-8">
<meta http-equiv="x-ua-compatible" content="ie=edge">
<title>CICADA</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">
Documentation update.
2021-09-03 01:48:41 +02:00
<link rel="stylesheet" href="../styles/style.css">
<link rel="stylesheet" href="../styles/dark.css" media="(prefers-color-scheme: dark)">
Add docs.
2021-05-10 20:56:20 +02:00
</head>
<body>
<div class="navbar navbar-default navbar-fixed-top visible-xs">
<a href="../" class="navbar-brand">CICADA</a>
<button type="button" class="btn btn-default btn-menu ion-ios-menu" id="btn-menu"></button>
</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="hidden-xs menu">
<compodoc-menu mode="normal"></compodoc-menu>
</div>
<!-- START CONTENT -->
<div class="content injectable">
<div class="content-data">
<ol class="breadcrumb">
<li>Injectables</li>
Documentation update.
2021-09-03 01:48:41 +02:00
<li >LoggingService</li>
Add docs.
2021-05-10 20:56:20 +02:00
</ol>
<ul class="nav nav-tabs" role="tablist">
<li class="active">
<a href="#info" role="tab" id="info-tab" data-toggle="tab" data-link="info">Info</a>
</li>
<li >
<a href="#source" role="tab" id="source-tab" data-toggle="tab" data-link="source">Source</a>
</li>
</ul>
<div class="tab-content">
<div class="tab-pane fade active in" id="c-info">
<p class="comment">
<h3>File</h3>
</p>
<p class="comment">
<code>src/app/_services/logging.service.ts</code>
</p>
Documentation update.
2021-09-03 01:48:41 +02:00
Add docs.
2021-05-10 20:56:20 +02:00
<section>
<h3 id="index">Index</h3>
<table class="table table-sm table-bordered index-table">
<tbody>
<tr>
<td class="col-md-4">
<h6><b>Methods</b></h6>
</td>
</tr>
<tr>
<td class="col-md-4">
<ul class="index-list">
<li>
Documentation update.
2021-09-03 01:48:41 +02:00
<a href="#sendDebugLevelMessage" >sendDebugLevelMessage</a>
Add docs.
2021-05-10 20:56:20 +02:00
</li>
<li>
Documentation update.
2021-09-03 01:48:41 +02:00
<a href="#sendErrorLevelMessage" >sendErrorLevelMessage</a>
Add docs.
2021-05-10 20:56:20 +02:00
</li>
<li>
Documentation update.
2021-09-03 01:48:41 +02:00
<a href="#sendFatalLevelMessage" >sendFatalLevelMessage</a>
Add docs.
2021-05-10 20:56:20 +02:00
</li>
<li>
Documentation update.
2021-09-03 01:48:41 +02:00
<a href="#sendInfoLevelMessage" >sendInfoLevelMessage</a>
Add docs.
2021-05-10 20:56:20 +02:00
</li>
<li>
Documentation update.
2021-09-03 01:48:41 +02:00
<a href="#sendLogLevelMessage" >sendLogLevelMessage</a>
Add docs.
2021-05-10 20:56:20 +02:00
</li>
<li>
Documentation update.
2021-09-03 01:48:41 +02:00
<a href="#sendTraceLevelMessage" >sendTraceLevelMessage</a>
Add docs.
2021-05-10 20:56:20 +02:00
</li>
<li>
Documentation update.
2021-09-03 01:48:41 +02:00
<a href="#sendWarnLevelMessage" >sendWarnLevelMessage</a>
Add docs.
2021-05-10 20:56:20 +02:00
</li>
</ul>
</td>
</tr>
</tbody>
</table>
</section>
<section>
<h3 id="constructor">Constructor</h3>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<code>constructor(logger: NGXLogger)</code>
</td>
</tr>
<tr>
<td class="col-md-4">
Documentation update.
2021-09-03 01:48:41 +02:00
<div class="io-line">Defined in <a href="" data-line="7" class="link-to-prism">src/app/_services/logging.service.ts:7</a></div>
Add docs.
2021-05-10 20:56:20 +02:00
</td>
</tr>
<tr>
<td class="col-md-4">
<div>
<b>Parameters :</b>
<table class="params">
<thead>
<tr>
<td>Name</td>
<td>Type</td>
<td>Optional</td>
</tr>
</thead>
<tbody>
<tr>
<td>logger</td>
<td>
<code>NGXLogger</code>
</td>
<td>
No
</td>
</tr>
</tbody>
</table>
</div>
</td>
</tr>
</tbody>
</table>
</section>
<section>
<h3 id="methods">
Methods
</h3>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="sendDebugLevelMessage"></a>
<span class="name">
Documentation update.
2021-09-03 01:48:41 +02:00
<span ><b>sendDebugLevelMessage</b></span>
Add docs.
2021-05-10 20:56:20 +02:00
<a href="#sendDebugLevelMessage"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<code>sendDebugLevelMessage(message: <a href="https://www.typescriptlang.org/docs/handbook/basic-types.html" target="_blank">any</a>, source: <a href="https://www.typescriptlang.org/docs/handbook/basic-types.html" target="_blank">any</a>, error: <a href="https://www.typescriptlang.org/docs/handbook/basic-types.html" target="_blank">any</a>)</code>
</td>
</tr>
<tr>
<td class="col-md-4">
Documentation update.
2021-09-03 01:48:41 +02:00
<div class="io-line">Defined in <a href="" data-line="19"
class="link-to-prism">src/app/_services/logging.service.ts:19</a></div>
Add docs.
2021-05-10 20:56:20 +02:00
</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>message</td>
<td>
<code><a href="https://www.typescriptlang.org/docs/handbook/basic-types.html" target="_blank" >any</a></code>
</td>
<td>
No
</td>
</tr>
<tr>
<td>source</td>
<td>
<code><a href="https://www.typescriptlang.org/docs/handbook/basic-types.html" target="_blank" >any</a></code>
</td>
<td>
No
</td>
</tr>
<tr>
<td>error</td>
<td>
<code><a href="https://www.typescriptlang.org/docs/handbook/basic-types.html" target="_blank" >any</a></code>
</td>
<td>
No
</td>
</tr>
</tbody>
</table>
</div>
<div>
</div>
<div class="io-description">
<b>Returns : </b> <code><a href="https://www.typescriptlang.org/docs/handbook/basic-types.html" target="_blank" >void</a></code>
</div>
<div class="io-description">
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="sendErrorLevelMessage"></a>
<span class="name">
Documentation update.
2021-09-03 01:48:41 +02:00
<span ><b>sendErrorLevelMessage</b></span>
Add docs.
2021-05-10 20:56:20 +02:00
<a href="#sendErrorLevelMessage"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<code>sendErrorLevelMessage(message: <a href="https://www.typescriptlang.org/docs/handbook/basic-types.html" target="_blank">any</a>, source: <a href="https://www.typescriptlang.org/docs/handbook/basic-types.html" target="_blank">any</a>, error: <a href="https://www.typescriptlang.org/docs/handbook/basic-types.html" target="_blank">any</a>)</code>
</td>
</tr>
<tr>
<td class="col-md-4">
Documentation update.
2021-09-03 01:48:41 +02:00
<div class="io-line">Defined in <a href="" data-line="35"
class="link-to-prism">src/app/_services/logging.service.ts:35</a></div>
Add docs.
2021-05-10 20:56:20 +02:00
</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>message</td>
<td>
<code><a href="https://www.typescriptlang.org/docs/handbook/basic-types.html" target="_blank" >any</a></code>
</td>
<td>
No
</td>
</tr>
<tr>
<td>source</td>
<td>
<code><a href="https://www.typescriptlang.org/docs/handbook/basic-types.html" target="_blank" >any</a></code>
</td>
<td>
No
</td>
</tr>
<tr>
<td>error</td>
<td>
<code><a href="https://www.typescriptlang.org/docs/handbook/basic-types.html" target="_blank" >any</a></code>
</td>
<td>
No
</td>
</tr>
</tbody>
</table>
</div>
<div>
</div>
<div class="io-description">
<b>Returns : </b> <code><a href="https://www.typescriptlang.org/docs/handbook/basic-types.html" target="_blank" >void</a></code>
</div>
<div class="io-description">
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="sendFatalLevelMessage"></a>
<span class="name">
Documentation update.
2021-09-03 01:48:41 +02:00
<span ><b>sendFatalLevelMessage</b></span>
Add docs.
2021-05-10 20:56:20 +02:00
<a href="#sendFatalLevelMessage"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<code>sendFatalLevelMessage(message: <a href="https://www.typescriptlang.org/docs/handbook/basic-types.html" target="_blank">any</a>, source: <a href="https://www.typescriptlang.org/docs/handbook/basic-types.html" target="_blank">any</a>, error: <a href="https://www.typescriptlang.org/docs/handbook/basic-types.html" target="_blank">any</a>)</code>
</td>
</tr>
<tr>
<td class="col-md-4">
Documentation update.
2021-09-03 01:48:41 +02:00
<div class="io-line">Defined in <a href="" data-line="39"
class="link-to-prism">src/app/_services/logging.service.ts:39</a></div>
Add docs.
2021-05-10 20:56:20 +02:00
</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>message</td>
<td>
<code><a href="https://www.typescriptlang.org/docs/handbook/basic-types.html" target="_blank" >any</a></code>
</td>
<td>
No
</td>
</tr>
<tr>
<td>source</td>
<td>
<code><a href="https://www.typescriptlang.org/docs/handbook/basic-types.html" target="_blank" >any</a></code>
</td>
<td>
No
</td>
</tr>
<tr>
<td>error</td>
<td>
<code><a href="https://www.typescriptlang.org/docs/handbook/basic-types.html" target="_blank" >any</a></code>
</td>
<td>
No
</td>
</tr>
</tbody>
</table>
</div>
<div>
</div>
<div class="io-description">
<b>Returns : </b> <code><a href="https://www.typescriptlang.org/docs/handbook/basic-types.html" target="_blank" >void</a></code>
</div>
<div class="io-description">
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="sendInfoLevelMessage"></a>
<span class="name">
Documentation update.
2021-09-03 01:48:41 +02:00
<span ><b>sendInfoLevelMessage</b></span>
Add docs.
2021-05-10 20:56:20 +02:00
<a href="#sendInfoLevelMessage"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<code>sendInfoLevelMessage(message: <a href="https://www.typescriptlang.org/docs/handbook/basic-types.html" target="_blank">any</a>)</code>
</td>
</tr>
<tr>
<td class="col-md-4">
Documentation update.
2021-09-03 01:48:41 +02:00
<div class="io-line">Defined in <a href="" data-line="23"
class="link-to-prism">src/app/_services/logging.service.ts:23</a></div>
Add docs.
2021-05-10 20:56:20 +02:00
</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>message</td>
<td>
<code><a href="https://www.typescriptlang.org/docs/handbook/basic-types.html" target="_blank" >any</a></code>
</td>
<td>
No
</td>
</tr>
</tbody>
</table>
</div>
<div>
</div>
<div class="io-description">
<b>Returns : </b> <code><a href="https://www.typescriptlang.org/docs/handbook/basic-types.html" target="_blank" >void</a></code>
</div>
<div class="io-description">
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="sendLogLevelMessage"></a>
<span class="name">
Documentation update.
2021-09-03 01:48:41 +02:00
<span ><b>sendLogLevelMessage</b></span>
Add docs.
2021-05-10 20:56:20 +02:00
<a href="#sendLogLevelMessage"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<code>sendLogLevelMessage(message: <a href="https://www.typescriptlang.org/docs/handbook/basic-types.html" target="_blank">any</a>, source: <a href="https://www.typescriptlang.org/docs/handbook/basic-types.html" target="_blank">any</a>, error: <a href="https://www.typescriptlang.org/docs/handbook/basic-types.html" target="_blank">any</a>)</code>
</td>
</tr>
<tr>
<td class="col-md-4">
Documentation update.
2021-09-03 01:48:41 +02:00
<div class="io-line">Defined in <a href="" data-line="27"
class="link-to-prism">src/app/_services/logging.service.ts:27</a></div>
Add docs.
2021-05-10 20:56:20 +02:00
</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>message</td>
<td>
<code><a href="https://www.typescriptlang.org/docs/handbook/basic-types.html" target="_blank" >any</a></code>
</td>
<td>
No
</td>
</tr>
<tr>
<td>source</td>
<td>
<code><a href="https://www.typescriptlang.org/docs/handbook/basic-types.html" target="_blank" >any</a></code>
</td>
<td>
No
</td>
</tr>
<tr>
<td>error</td>
<td>
<code><a href="https://www.typescriptlang.org/docs/handbook/basic-types.html" target="_blank" >any</a></code>
</td>
<td>
No
</td>
</tr>
</tbody>
</table>
</div>
<div>
</div>
<div class="io-description">
<b>Returns : </b> <code><a href="https://www.typescriptlang.org/docs/handbook/basic-types.html" target="_blank" >void</a></code>
</div>
<div class="io-description">
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="sendTraceLevelMessage"></a>
<span class="name">
Documentation update.
2021-09-03 01:48:41 +02:00
<span ><b>sendTraceLevelMessage</b></span>
Add docs.
2021-05-10 20:56:20 +02:00
<a href="#sendTraceLevelMessage"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<code>sendTraceLevelMessage(message: <a href="https://www.typescriptlang.org/docs/handbook/basic-types.html" target="_blank">any</a>, source: <a href="https://www.typescriptlang.org/docs/handbook/basic-types.html" target="_blank">any</a>, error: <a href="https://www.typescriptlang.org/docs/handbook/basic-types.html" target="_blank">any</a>)</code>
</td>
</tr>
<tr>
<td class="col-md-4">
Documentation update.
2021-09-03 01:48:41 +02:00
<div class="io-line">Defined in <a href="" data-line="15"
class="link-to-prism">src/app/_services/logging.service.ts:15</a></div>
Add docs.
2021-05-10 20:56:20 +02:00
</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>message</td>
<td>
<code><a href="https://www.typescriptlang.org/docs/handbook/basic-types.html" target="_blank" >any</a></code>
</td>
<td>
No
</td>
</tr>
<tr>
<td>source</td>
<td>
<code><a href="https://www.typescriptlang.org/docs/handbook/basic-types.html" target="_blank" >any</a></code>
</td>
<td>
No
</td>
</tr>
<tr>
<td>error</td>
<td>
<code><a href="https://www.typescriptlang.org/docs/handbook/basic-types.html" target="_blank" >any</a></code>
</td>
<td>
No
</td>
</tr>
</tbody>
</table>
</div>
<div>
</div>
<div class="io-description">
<b>Returns : </b> <code><a href="https://www.typescriptlang.org/docs/handbook/basic-types.html" target="_blank" >void</a></code>
</div>
<div class="io-description">
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="sendWarnLevelMessage"></a>
<span class="name">
Documentation update.
2021-09-03 01:48:41 +02:00
<span ><b>sendWarnLevelMessage</b></span>
Add docs.
2021-05-10 20:56:20 +02:00
<a href="#sendWarnLevelMessage"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<code>sendWarnLevelMessage(message: <a href="https://www.typescriptlang.org/docs/handbook/basic-types.html" target="_blank">any</a>, error: <a href="https://www.typescriptlang.org/docs/handbook/basic-types.html" target="_blank">any</a>)</code>
</td>
</tr>
<tr>
<td class="col-md-4">
Documentation update.
2021-09-03 01:48:41 +02:00
<div class="io-line">Defined in <a href="" data-line="31"
class="link-to-prism">src/app/_services/logging.service.ts:31</a></div>
Add docs.
2021-05-10 20:56:20 +02:00
</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>message</td>
<td>
<code><a href="https://www.typescriptlang.org/docs/handbook/basic-types.html" target="_blank" >any</a></code>
</td>
<td>
No
</td>
</tr>
<tr>
<td>error</td>
<td>
<code><a href="https://www.typescriptlang.org/docs/handbook/basic-types.html" target="_blank" >any</a></code>
</td>
<td>
No
</td>
</tr>
</tbody>
</table>
</div>
<div>
</div>
<div class="io-description">
<b>Returns : </b> <code><a href="https://www.typescriptlang.org/docs/handbook/basic-types.html" target="_blank" >void</a></code>
</div>
<div class="io-description">
</div>
</td>
</tr>
</tbody>
</table>
</section>
</div>
<div class="tab-pane fade tab-source-code" id="c-source">
Format docs using linter and prettier.
2021-05-11 19:51:48 +02:00
<pre class="line-numbers compodoc-sourcecode"><code class="language-typescript">import { Injectable, isDevMode } from &#x27;@angular/core&#x27;;
import { NGXLogger } from &#x27;ngx-logger&#x27;;
Add docs.
2021-05-10 20:56:20 +02:00
@Injectable({
Format docs using linter and prettier.
2021-05-11 19:51:48 +02:00
providedIn: &#x27;root&#x27;,
Add docs.
2021-05-10 20:56:20 +02:00
})
export class LoggingService {
constructor(private logger: NGXLogger) {
// TRACE|DEBUG|INFO|LOG|WARN|ERROR|FATAL|OFF
if (isDevMode()) {
this.sendInfoLevelMessage(&#x27;Dropping into debug mode&#x27;);
}
}
sendTraceLevelMessage(message: any, source: any, error: any): void {
this.logger.trace(message, source, error);
}
sendDebugLevelMessage(message: any, source: any, error: any): void {
this.logger.debug(message, source, error);
}
sendInfoLevelMessage(message: any): void {
this.logger.info(message);
}
sendLogLevelMessage(message: any, source: any, error: any): void {
this.logger.log(message, source, error);
}
sendWarnLevelMessage(message: any, error: any): void {
this.logger.warn(message, error);
}
sendErrorLevelMessage(message: any, source: any, error: any): void {
this.logger.error(message, source, error);
}
sendFatalLevelMessage(message: any, source: any, error: any): void {
this.logger.fatal(message, source, error);
}
}
</code></pre>
</div>
</div>
</div><div class="search-results">
<div class="has-results">
<h1 class="search-results-title"><span class='search-results-count'></span> result-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>
<script>
var COMPODOC_CURRENT_PAGE_DEPTH = 1;
var COMPODOC_CURRENT_PAGE_CONTEXT = 'injectable';
var COMPODOC_CURRENT_PAGE_URL = 'LoggingService.html';
var MAX_SEARCH_RESULTS = 15;
</script>
<script src="../js/libs/custom-elements.min.js"></script>
<script src="../js/libs/lit-html.js"></script>
Documentation update.
2021-09-03 01:48:41 +02:00
<script type="module" src="../js/menu-wc.js" defer></script>
<script nomodule src="../js/menu-wc_es5.js" defer></script>
Add docs.
2021-05-10 20:56:20 +02:00
<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>
Reference in New Issue Copy Permalink