amos-ionic-logging

<!doctype html> <html class="no-js" lang=""> <head> <meta charset="utf-8"> <meta http-equiv="x-ua-compatible" content="ie=edge"> <title>ionic-logging-service</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"> </head> <body> <div class="navbar navbar-default navbar-fixed-top visible-xs"> <a href="../" class="navbar-brand">ionic-logging-service</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>  <div class="content class"> <div class="content-data"> <ol class="breadcrumb"> <li>Classes</li> <li>MemoryAppender</li> </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/lib/memory-appender.model.ts</code> </p> <p class="comment"> <h3>Description</h3> </p> <p class="comment"> <p>An appender which stores the log messages in the browser's memory.</p> <p>The MemoryAppender is enabled by default. If you do not specify anything else, it is using this configuration:</p> <p>```JSON</p> <ul> <li>{</li> <li>"memoryAppender": [</li> <li>{</li> <li>"maxMessages": 250,</li> <li>"threshold": "ALL"</li> <li>}</li> <li>}</li> <li>```</li> </ul> </p> <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> <span class="modifier">Public</span> <a href="#append">append</a> </li> <li> <span class="modifier">Public</span> <a href="#configure">configure</a> </li> <li> <span class="modifier">Public</span> <a href="#getLogMessages">getLogMessages</a> </li> <li> <span class="modifier">Public</span> <a href="#getMaxMessages">getMaxMessages</a> </li> <li> <span class="modifier">Public</span> <a href="#removeLogMessages">removeLogMessages</a> </li> <li> <span class="modifier">Public</span> <a href="#setMaxMessages">setMaxMessages</a> </li> <li> <span class="modifier">Public</span> <a href="#setOnLogMessagesChangedCallback">setOnLogMessagesChangedCallback</a> </li> <li> <span class="modifier">Public</span> <a href="#toString">toString</a> </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(configuration?: <a href="../interfaces/MemoryAppenderConfiguration.html">MemoryAppenderConfiguration</a>)</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/memory-appender.model.ts:34</a></div> </td> </tr> <tr> <td class="col-md-4"> <div class="io-description"><p>Creates a new instance of the appender.</p> </div> <div> <b>Parameters :</b> <table class="params"> <thead> <tr> <td>Name</td> <td>Type</td> <td>Optional</td> <td>Description</td> </tr> </thead> <tbody> <tr> <td>configuration</td> <td> <code><a href="../interfaces/MemoryAppenderConfiguration.html" target="_self" >MemoryAppenderConfiguration</a></code> </td> <td> Yes </td> <td> <code><p>configuration for the appender.</p> </code> </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="append"></a> <span class="name"> <b> <span class="modifier">Public</span> append </b> <a href="#append"><span class="icon ion-ios-link"></span></a> </span> </td> </tr> <tr> <td class="col-md-4"> <span class="modifier-icon icon ion-ios-reset"></span> <code>append(loggingEvent: log4javascript.LoggingEvent)</code> </td> </tr> <tr> <td class="col-md-4"> <div class="io-line">Defined in <a href="" data-line="78" class="link-to-prism">src/lib/memory-appender.model.ts:78</a></div> </td> </tr> <tr> <td class="col-md-4"> <div class="io-description"><p>Appender-specific method to append a log message.</p> </div> <div class="io-description"> <b>Parameters :</b> <table class="params"> <thead> <tr> <td>Name</td> <td>Type</td> <td>Optional</td> <td>Description</td> </tr> </thead> <tbody> <tr> <td>loggingEvent</td> <td> <code>log4javascript.LoggingEvent</code> </td> <td> No </td> <td> <p>event to be appended.</p> </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="configure"></a> <span class="name"> <b> <span class="modifier">Public</span> configure </b> <a href="#configure"><span class="icon ion-ios-link"></span></a> </span> </td> </tr> <tr> <td class="col-md-4"> <span class="modifier-icon icon ion-ios-reset"></span> <code>configure(configuration: <a href="../interfaces/MemoryAppenderConfiguration.html">MemoryAppenderConfiguration</a>)</code> </td> </tr> <tr> <td class="col-md-4"> <div class="io-line">Defined in <a href="" data-line="61" class="link-to-prism">src/lib/memory-appender.model.ts:61</a></div> </td> </tr> <tr> <td class="col-md-4"> <div class="io-description"><p>Configures the logging depending on the given configuration. Only the defined properties get overwritten.</p> </div> <div class="io-description"> <b>Parameters :</b> <table class="params"> <thead> <tr> <td>Name</td> <td>Type</td> <td>Optional</td> <td>Description</td> </tr> </thead> <tbody> <tr> <td>configuration</td> <td> <code><a href="../interfaces/MemoryAppenderConfiguration.html" target="_self" >MemoryAppenderConfiguration</a></code> </td> <td> No </td> <td> <p>configuration data.</p> </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="getLogMessages"></a> <span class="name"> <b> <span class="modifier">Public</span> getLogMessages </b> <a href="#getLogMessages"><span class="icon ion-ios-link"></span></a> </span> </td> </tr> <tr> <td class="col-md-4"> <span class="modifier-icon icon ion-ios-reset"></span> <code>getLogMessages()</code> </td> </tr> <tr> <td class="col-md-4"> <div class="io-line">Defined in <a href="" data-line="134" class="link-to-prism">src/lib/memory-appender.model.ts:134</a></div> </td> </tr> <tr> <td class="col-md-4"> <div class="io-description"><p>Gets all messages stored in memory.</p> </div> <div> </div> <div class="io-description"> <b>Returns : </b> <code><a href="../interfaces/LogMessage.html" target="_self" >LogMessage[]</a></code> </div> <div class="io-description"> <p>stored messages</p> </div> </td> </tr> </tbody> </table> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <a name="getMaxMessages"></a> <span class="name"> <b> <span class="modifier">Public</span> getMaxMessages </b> <a href="#getMaxMessages"><span class="icon ion-ios-link"></span></a> </span> </td> </tr> <tr> <td class="col-md-4"> <span class="modifier-icon icon ion-ios-reset"></span> <code>getMaxMessages()</code> </td> </tr> <tr> <td class="col-md-4"> <div class="io-line">Defined in <a href="" data-line="111" class="link-to-prism">src/lib/memory-appender.model.ts:111</a></div> </td> </tr> <tr> <td class="col-md-4"> <div class="io-description"><p>Get the maximum number of messages which will be stored in memory.</p> </div> <div class="io-description"> <b>Returns : </b> <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/number" target="_blank" >number</a></code> </div> </td> </tr> </tbody> </table> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <a name="removeLogMessages"></a> <span class="name"> <b> <span class="modifier">Public</span> removeLogMessages </b> <a href="#removeLogMessages"><span class="icon ion-ios-link"></span></a> </span> </td> </tr> <tr> <td class="col-md-4"> <span class="modifier-icon icon ion-ios-reset"></span> <code>removeLogMessages()</code> </td> </tr> <tr> <td class="col-md-4"> <div class="io-line">Defined in <a href="" data-line="141" class="link-to-prism">src/lib/memory-appender.model.ts:141</a></div> </td> </tr> <tr> <td class="col-md-4"> <div class="io-description"><p>Remove all messages stored in memory.</p> </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> </td> </tr> </tbody> </table> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <a name="setMaxMessages"></a> <span class="name"> <b> <span class="modifier">Public</span> setMaxMessages </b> <a href="#setMaxMessages"><span class="icon ion-ios-link"></span></a> </span> </td> </tr> <tr> <td class="col-md-4"> <span class="modifier-icon icon ion-ios-reset"></span> <code>setMaxMessages(value: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/number" target="_blank">number</a>)</code> </td> </tr> <tr> <td class="col-md-4"> <div class="io-line">Defined in <a href="" data-line="121" class="link-to-prism">src/lib/memory-appender.model.ts:121</a></div> </td> </tr> <tr> <td class="col-md-4"> <div class="io-description"><p>Set the maximum number of messages which will be stored in memory.</p> <p>If the appender stores currently more messages than the new value allows, the oldest messages get removed.</p> </div> <div class="io-description"> <b>Parameters :</b> <table class="params"> <thead> <tr> <td>Name</td> <td>Type</td> <td>Optional</td> <td>Description</td> </tr> </thead> <tbody> <tr> <td>value</td> <td> <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/number" target="_blank" >number</a></code> </td> <td> No </td> <td> <p>new maximum number</p> </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="setOnLogMessagesChangedCallback"></a> <span class="name"> <b> <span class="modifier">Public</span> setOnLogMessagesChangedCallback </b> <a href="#setOnLogMessagesChangedCallback"><span class="icon ion-ios-link"></span></a> </span> </td> </tr> <tr> <td class="col-md-4"> <span class="modifier-icon icon ion-ios-reset"></span> <code>setOnLogMessagesChangedCallback(callback: (message: <a href="../interfaces/LogMessage.html">LogMessage</a>) => void)</code> </td> </tr> <tr> <td class="col-md-4"> <div class="io-line">Defined in <a href="" data-line="150" class="link-to-prism">src/lib/memory-appender.model.ts:150</a></div> </td> </tr> <tr> <td class="col-md-4"> <div class="io-description"><p>Registers a callback which will be called every time a new message is appended. This could be useful if you want to show new messages in realtime.</p> </div> <div class="io-description"> <b>Parameters :</b> <table class="params"> <thead> <tr> <td>Name</td> <td>Type</td> <td>Optional</td> <td>Description</td> </tr> </thead> <tbody> <tr> <td>callback</td> <td> <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/function" target="_blank" >function</a></code> </td> <td> No </td> <td> <p>callback to be called</p> </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="toString"></a> <span class="name"> <b> <span class="modifier">Public</span> toString </b> <a href="#toString"><span class="icon ion-ios-link"></span></a> </span> </td> </tr> <tr> <td class="col-md-4"> <span class="modifier-icon icon ion-ios-reset"></span> <code>toString()</code> </td> </tr> <tr> <td class="col-md-4"> <div class="io-line">Defined in <a href="" data-line="104" class="link-to-prism">src/lib/memory-appender.model.ts:104</a></div> </td> </tr> <tr> <td class="col-md-4"> <div class="io-description"><p>Gets the appender's name. Mainly for unit testing purposes.</p> </div> <div> </div> <div class="io-description"> <b>Returns : </b> <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string" target="_blank" >string</a></code> </div> <div class="io-description"> <p>appender's name</p> </div> </td> </tr> </tbody> </table> </section> </div> <div class="tab-pane fade tab-source-code" id="c-source"> <pre class="line-numbers compodoc-sourcecode"><code class="language-typescript">import * as log4javascript from "log4javascript"; import { LogLevelConverter } from "./log-level.converter"; import { LogLevel } from "./log-level.model"; import { LogMessage } from "./log-message.model"; import { MemoryAppenderConfiguration } from "./memory-appender.configuration"; /** * An appender which stores the log messages in the browser's memory. * * The MemoryAppender is enabled by default. * If you do not specify anything else, it is using this configuration: * * ```JSON * { * "memoryAppender": [ * { * "maxMessages": 250, * "threshold": "ALL" * } * } * ``` */ export class MemoryAppender extends log4javascript.Appender { private static maxMessagesDefault = 250; private static thresholdDefault = "ALL"; private maxMessages: number; // tslint:disable-next-line:completed-docs private logMessages: LogMessage[]; // tslint:disable-next-line:completed-docs private onLogMessagesChangedCallback: (message: LogMessage) => void; /** * Creates a new instance of the appender. * @param configuration configuration for the appender. */ constructor(configuration?: MemoryAppenderConfiguration) { super(); this.logMessages = []; // process configuration configuration = configuration || {}; this.configure({ maxMessages: configuration.maxMessages || MemoryAppender.maxMessagesDefault, threshold: configuration.threshold || MemoryAppender.thresholdDefault, }); this.maxMessages = MemoryAppender.maxMessagesDefault; } /** * Configures the logging depending on the given configuration. * Only the defined properties get overwritten. * * @param configuration configuration data. */ public configure(configuration: MemoryAppenderConfiguration): void { if (configuration) { if (configuration.maxMessages) { this.setMaxMessages(configuration.maxMessages); } if (configuration.threshold) { const convertedThreshold = LogLevelConverter.levelToLog4Javascript( LogLevelConverter.levelFromString(configuration.threshold)); this.setThreshold(convertedThreshold); } } } /** * Appender-specific method to append a log message. * @param loggingEvent event to be appended. */ public append(loggingEvent: log4javascript.LoggingEvent): void { // if logMessages is already full, remove oldest element while (this.logMessages.length >= this.maxMessages) { this.logMessages.shift(); } // add event to logMessages const message: LogMessage = { level: LogLevel[LogLevelConverter.levelFromLog4Javascript(loggingEvent.level)], logger: typeof loggingEvent.logger === "object" ? loggingEvent.logger.name : undefined, message: loggingEvent.messages.slice(1), methodName: loggingEvent.messages[0], timeStamp: loggingEvent.timeStamp, }; this.logMessages.push(message); // inform about new message if (typeof this.onLogMessagesChangedCallback === "function") { this.onLogMessagesChangedCallback(message); } } /** * Gets the appender's name. * Mainly for unit testing purposes. * @return appender's name */ public toString(): string { return "Ionic.Logging.MemoryAppender"; } /** * Get the maximum number of messages which will be stored in memory. */ public getMaxMessages(): number { return this.maxMessages; } /** * Set the maximum number of messages which will be stored in memory. * * If the appender stores currently more messages than the new value allows, the oldest messages get removed. * @param value new maximum number */ public setMaxMessages(value: number): void { this.maxMessages = value; // if there are too much logMessages for the new value, remove oldest messages if (this.logMessages.length > this.maxMessages) { this.logMessages.splice(0, this.logMessages.length - this.maxMessages); } } /** * Gets all messages stored in memory. * @return stored messages */ public getLogMessages(): LogMessage[] { return this.logMessages; } /** * Remove all messages stored in memory. */ public removeLogMessages(): void { this.logMessages.splice(0); } /** * Registers a callback which will be called every time a new message is appended. * This could be useful if you want to show new messages in realtime. * @param callback callback to be called */ public setOnLogMessagesChangedCallback(callback: (message: LogMessage) => void): void { this.onLogMessagesChangedCallback = callback; } } </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>  </div> </div> <script> var COMPODOC_CURRENT_PAGE_DEPTH = 1; var COMPODOC_CURRENT_PAGE_CONTEXT = 'class'; var COMPODOC_CURRENT_PAGE_URL = 'MemoryAppender.html'; var MAX_SEARCH_RESULTS = 15; </script> <script src="../js/libs/custom-elements.min.js"></script> <script src="../js/libs/lit-html.js"></script>  <script src="../js/libs/custom-elements-es5-adapter.js" charset="utf-8" defer></script> <script src="../js/menu-wc.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>