@qubit-ltd/logging 1.4.8 → 1.4.10

package/doc/api/data/search.json

@@ -0,0 +1 @@
+{"list":[{"title":"FACTORY_DEFAULT_APPENDER","link":"<a href=\"global.html#FACTORY_DEFAULT_APPENDER\">FACTORY_DEFAULT_APPENDER</a>","description":"<p>The factory value of the Logger class's default log appender, which is\nthe standard output pipe of the console.</p>"},{"title":"FACTORY_DEFAULT_LEVEL","link":"<a href=\"global.html#FACTORY_DEFAULT_LEVEL\">FACTORY_DEFAULT_LEVEL</a>","description":"<p>The factory value of the Logger class's default logging level,\nwhich is <code>DEBUG</code>.</p>"},{"title":"HasLogger","link":"<a href=\"global.html#HasLogger\">HasLogger</a>","description":"<p>A decorator to add a named logger to a class.</p>\n<p>This decorator will add a named logger to the class, which can be accessed\nvia the <code>logger</code> property of the class.</p>\n<p>Example usage:</p>\n<pre class=\"prettyprint source lang-js\"><code>import { HasLogger } from '@haixing_hu/logging';\n\n&#064;HasLogger\nclass MyClass {\n   foo() {\n     this.logger.debug('This is MyClass.foo()');\n   }\n}\n</code></pre>\n<p>The following is another example usage with the class component of Vue.js:</p>\n<pre class=\"prettyprint source lang-js\"><code>import { Component, toVue } from '@haixing_hu/vue3-class-component';\nimport { HasLogger, Log } from '@haixing_hu/logging';\n\n&#064;Component({\n  template: '&lt;p &#064;click=&quot;foo&quot;>{{ message }}&lt;/p>',\n})\n&#064;HasLogger\nclass MyComponent {\n   &#064;Log\n   foo() {\n     this.logger.debug('This is MyComponent.foo()');\n   }\n}\n\nexport default toVue(MyComponent);\n</code></pre>\n<p><strong>NOTE</strong>: the order of the decorators is IMPORTANT. The <code>@HasLogger</code> decorator\nmust be placed <strong>AFTER</strong> the <code>@Component</code> decorator.</p>"},{"title":"LOGGING_LEVELS","link":"<a href=\"global.html#LOGGING_LEVELS\">LOGGING_LEVELS</a>","description":"<p>Predefined logging levels.</p>"},{"title":"Log","link":"<a href=\"global.html#Log\">Log</a>","description":"<p>Defines a class method decorator that modifies the target method and prints\nits calling signature in the log, including class name, method name and\nparameters.</p>\n<p>Note that only non-constructor class method can be decorated by this decorator.\nThe global function and class constructor CANNOT be decorated by this decorator.</p>\n<p>Usage example:</p>\n<pre class=\"prettyprint source lang-js\"><code>import { Log } from '@haixing_hu/logging';\n\nclass Person {\n  &#064;Log\n  eat(meal) {\n    ...\n  }\n}\n\nconst person = new Person();\nconst meal = new Meal();\nperson.eat(meal);   // 日志中将会打印此方法调用的签名\n</code></pre>"},{"title":"Logger","link":"<a href=\"Logger.html\">Logger</a>","description":"<p>Construct a log object.</p>\n<p><strong>NOTE</strong>: Do NOT call this constructor directly. Use the static method\n<code>Logger.getLogger()</code> instead.</p>"},{"title":"Logger#disable","link":"<a href=\"Logger.html#disable\">disable</a>","description":"<p>Disable this logging object.</p>"},{"title":"Logger#enable","link":"<a href=\"Logger.html#enable\">enable</a>","description":"<p>Enable this logging object.</p>"},{"title":"Logger#getAppender","link":"<a href=\"Logger.html#getAppender\">getAppender</a>","description":"<p>Get the appender of this logger.</p>"},{"title":"Logger#getLevel","link":"<a href=\"Logger.html#getLevel\">getLevel</a>","description":"<p>Get the logging level of this logger.</p>"},{"title":"Logger#getName","link":"<a href=\"Logger.html#getName\">getName</a>","description":"<p>Get the name of this logger.</p>"},{"title":"Logger#log","link":"<a href=\"Logger.html#log\">log</a>","description":"<p>Logs a message in the specified logging level.</p>"},{"title":"Logger#setAppender","link":"<a href=\"Logger.html#setAppender\">setAppender</a>","description":"<p>Set up a new Appender.</p>"},{"title":"Logger#setEnabled","link":"<a href=\"Logger.html#setEnabled\">setEnabled</a>","description":"<p>Enable or disable this log object.</p>"},{"title":"Logger#setLevel","link":"<a href=\"Logger.html#setLevel\">setLevel</a>","description":"<p>Set the logging level of this logger.</p>"},{"title":"Logger.clearAllLoggers","link":"<a href=\"Logger.html#.clearAllLoggers\">clearAllLoggers</a>","description":"<p>Clears all existing <code>Logger</code> instances.</p>"},{"title":"Logger.getDefaultAppender","link":"<a href=\"Logger.html#.getDefaultAppender\">getDefaultAppender</a>","description":"<p>Gets the default logging appender.</p>\n<p>The default logging appender is used to construct a new <code>Logger</code> instance\nif the logging appender of the new instance is not specified.</p>"},{"title":"Logger.getDefaultLevel","link":"<a href=\"Logger.html#.getDefaultLevel\">getDefaultLevel</a>","description":"<p>Gets the default logging level.</p>\n<p>The default logging level is used to construct a new <code>Logger</code> instance if\nthe logging level of the new instance is not specified.</p>"},{"title":"Logger.getLogger","link":"<a href=\"Logger.html#.getLogger\">getLogger</a>","description":"<p>Gets the <code>Logger</code> instance of the specified name, or constructs a new\n<code>Logger</code> instance if it does not exist.</p>"},{"title":"Logger.getLoggerLevel","link":"<a href=\"Logger.html#.getLoggerLevel\">getLoggerLevel</a>","description":"<p>Gets the logging level of the <code>Logger</code> instance of the specified name.</p>"},{"title":"Logger.reset","link":"<a href=\"Logger.html#.reset\">reset</a>","description":"<p>Resets all configurations of the <code>Logger</code> class to the factory values.</p>\n<p>This method is equivalent to calling the following methods in sequence:</p>\n<ul>\n<li><code>Logger.clearAllLoggers()</code></li>\n<li><code>Logger.resetDefaultLevel()</code></li>\n<li><code>Logger.resetDefaultAppender()</code></li>\n</ul>"},{"title":"Logger.resetAllAppenders","link":"<a href=\"Logger.html#.resetAllAppenders\">resetAllAppenders</a>","description":"<p>Sets the appender of all <code>Logger</code> instants to the default appender.</p>"},{"title":"Logger.resetAllLevels","link":"<a href=\"Logger.html#.resetAllLevels\">resetAllLevels</a>","description":"<p>Sets the logging level of all <code>Logger</code> instants to the default logging level.</p>"},{"title":"Logger.resetDefaultAppender","link":"<a href=\"Logger.html#.resetDefaultAppender\">resetDefaultAppender</a>","description":"<p>Resets the default logging appender to the factory value.</p>\n<p>The default logging appender is used to construct a new <code>Logger</code> instance\nif the logging appender of the new instance is not specified.</p>"},{"title":"Logger.resetDefaultLevel","link":"<a href=\"Logger.html#.resetDefaultLevel\">resetDefaultLevel</a>","description":"<p>Resets the default logging level to the factory value.</p>\n<p>The default logging level is used to construct a new <code>Logger</code> instance if\nthe logging level of the new instance is not specified.</p>"},{"title":"Logger.setAllAppenders","link":"<a href=\"Logger.html#.setAllAppenders\">setAllAppenders</a>","description":"<p>Sets the appender of all <code>Logger</code> instants.</p>"},{"title":"Logger.setAllLevels","link":"<a href=\"Logger.html#.setAllLevels\">setAllLevels</a>","description":"<p>Sets the logging level of all existing <code>Logger</code> instants.</p>"},{"title":"Logger.setDefaultAppender","link":"<a href=\"Logger.html#.setDefaultAppender\">setDefaultAppender</a>","description":"<p>Sets the default logging appender.</p>\n<p>The default logging appender is used to construct a new <code>Logger</code> instance\nif the logging appender of the new instance is not specified.</p>"},{"title":"Logger.setDefaultLevel","link":"<a href=\"Logger.html#.setDefaultLevel\">setDefaultLevel</a>","description":"<p>Sets the default logging level.</p>\n<p>The default logging level is used to construct a new <code>Logger</code> instance if\nthe logging level of the new instance is not specified.</p>"},{"title":"Logger.setLoggerLevel","link":"<a href=\"Logger.html#.setLoggerLevel\">setLoggerLevel</a>","description":"<p>Sets the logging level of the <code>Logger</code> instance of the specified name.</p>"}]}