@vvlad1973/simple-logger 1.2.2 → 2.0.2

package/src/helpers/helpers.ts

@@ -0,0 +1,92 @@
+import chalk from 'chalk';
+import { LoggerLevel, PreparedLogCall } from '../types/simple-logger.types.js';
+import { LoggerLevels } from '../constants/constants.js';
+
+/**
+ * Extracts the message and rest of the arguments from the provided array.
+ *
+ * If the first argument is an object and the second argument is a string, the second argument is considered the message.
+ * If the first argument is a string, it is considered the message.
+ * Otherwise, an empty message is returned.
+ *
+ * @param {unknown[]} args - The array of arguments to extract the message from.
+ * @return {{ msg: string; rest: unknown[] }} An object containing the extracted message and the rest of the arguments.
+ */
+export function extractMessage(args: unknown[]): {
+  msg: string;
+  rest: unknown[];
+} {
+  const [first, second, ...rest] = args;
+
+  if (
+    typeof first === 'object' &&
+    first !== null &&
+    typeof second === 'string'
+  ) {
+    return { msg: second, rest };
+  }
+
+  if (typeof first === 'string') {
+    return {
+      msg: first,
+      rest: [second, ...rest].filter((value) => value !== undefined),
+    };
+  }
+
+  return { msg: '', rest: [] };
+}
+
+/**
+ * Extracts the context object from the provided array of arguments.
+ *
+ * @param {unknown[]} args - The array of arguments to extract the context from.
+ * @return {Record<string, unknown>} The extracted context object, or an empty object if no context is found.
+ */
+export function extractContext(args: unknown[]): Record<string, unknown> {
+  const [first] = args;
+  if (typeof first === 'object' && first !== null && !Array.isArray(first)) {
+    return first as Record<string, unknown>;
+  }
+  return {};
+}
+
+/**
+ * Returns a string with the provided label colored according to the specified logging level.
+ *
+ * @param {LoggerLevel} level - The logging level to determine the color from.
+ * @param {string} label - The label to be colored.
+ * @return {string} The colored label.
+ */
+export function colorizeLevel(level: LoggerLevel, label: string): string {
+  switch (level) {
+    case LoggerLevels.DEBUG:
+    case LoggerLevels.TRACE:
+      return chalk.gray(label);
+    case LoggerLevels.INFO:
+      return chalk.green(label);
+    case LoggerLevels.WARN:
+      return chalk.yellow(label);
+    case LoggerLevels.ERROR:
+    case LoggerLevels.FATAL:
+      return chalk.red(label);
+    default:
+      return label;
+  }
+/**
+ * Prepares the log call by rearranging the provided arguments into a standardized format.
+ *
+ * @param {unknown[]} args - The array of arguments to prepare for the log call.
+ * @return {PreparedLogCall} The prepared log call arguments, or null if the input is invalid.
+ */
+}export function prepareLogCall(args: unknown[]): PreparedLogCall {
+  if (typeof args[0] === 'string') {
+    return [args[0], ...args.slice(1)];
+  }
+  if (typeof args[0] === 'object' && args[0] !== null) {
+    const msg = typeof args[1] === 'string' ? args[1] : undefined;
+    const rest = args.slice(msg ? 2 : 1);
+    return [args[0], msg, ...rest];
+  }
+  return null;
+}
+

package/src/helpers/validators.ts

@@ -0,0 +1,36 @@
+import { LoggerLevels } from '../constants/constants';
+import { ExternalLogger } from '../types/simple-logger.types.js';
+
+/**
+ * Checks if the provided logger is a valid ExternalLogger instance.
+ *
+ * @param {unknown} logger - The logger to validate.
+ * @return {logger is ExternalLogger} True if the logger is a valid ExternalLogger, false otherwise.
+ */
+export function isValidLogger(logger: unknown): logger is ExternalLogger {
+  const levels = Object.values(LoggerLevels);
+
+  if (typeof logger !== 'object' || logger === null) {
+    return false;
+  }
+
+  const candidate = logger as Record<string, unknown>;
+
+  return levels.some((level) => typeof candidate[level] === 'function');
+}
+
+/**
+ * Checks if the provided logger is an ExternalLogger instance with a child method.
+ *
+ * @param {unknown} logger - The logger to check.
+ * @return {logger is ExternalLogger & { child: Function }} True if the logger is an ExternalLogger with a child method, false otherwise.
+ */
+export function hasChild(
+  logger: unknown
+): logger is ExternalLogger & { child: Function } {
+  return (
+    typeof logger === 'object' &&
+    logger !== null &&
+    typeof (logger as any).child === 'function'
+  );
+}

package/src/index.ts

@@ -1,2 +1,7 @@
-export { default } from './simple-logger.js'
-export * from './simple-logger.js'
+import SimpleLogger from './classes/simple-logger';
+
+export default SimpleLogger;
+export { SimpleLogger };
+
+export * from './types/simple-logger.types';
+export * from './constants/constants.js';

package/src/types/simple-logger.types.ts

@@ -0,0 +1,40 @@
+import { LoggerLevels } from '../constants/constants';
+
+export type LoggerLevel = (typeof LoggerLevels)[keyof typeof LoggerLevels];
+
+export interface LogFn {
+  <T extends object>(obj: T, msg?: string, ...args: unknown[]): void;
+  (obj: unknown, msg?: string, ...args: unknown[]): void;
+  (msg: string, ...args: unknown[]): void;
+}
+
+export interface ExternalLogger {
+  trace?: LogFn;
+  debug?: LogFn;
+  info?: LogFn;
+  warn?: LogFn;
+  error?: LogFn;
+  fatal?: LogFn;
+  silent?: LogFn;
+  
+  level?: string;
+
+  child?(bindings: Record<string, unknown>): ExternalLogger;
+}
+
+export type LoggerFactory = (
+  options: Record<string, unknown>
+) => ExternalLogger;
+
+export interface LoggerOptions {
+  level?: LoggerLevel;
+  bindings?: Record<string, unknown>;
+  msgPrefix?: string;
+  transport?: unknown;
+  [key: string]: unknown;
+}
+
+export type PreparedLogCall =
+  | [string, ...unknown[]]
+  | [object, string?, ...unknown[]]
+  | null;

package/docs/media/index.html

@@ -1,39 +0,0 @@
-<!DOCTYPE html><html class="default" lang="en" data-base="."><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>@vvlad1973/simple-logger - v1.2.1</title><meta name="description" content="Documentation for @vvlad1973/simple-logger"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="assets/style.css"/><link rel="stylesheet" href="assets/highlight.css"/><script defer src="assets/main.js"></script><script async src="assets/icons.js" id="tsd-icons-script"></script><script async src="assets/search.js" id="tsd-search-script"></script><script async src="assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search"><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="index.html" class="title">@vvlad1973/simple-logger - v1.2.1</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><h1>@vvlad1973/simple-logger - v1.2.1</h1></div><div class="tsd-panel tsd-typography"><a id="vvlad1973simple-logger" class="tsd-anchor"></a><h1 class="tsd-anchor-link">@vvlad1973/simple-logger<a href="#vvlad1973simple-logger" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h1><p>A simple logger module for Node.js applications with support for various logging levels.</p>
-<a id="installation" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Installation<a href="#installation" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><pre><code class="bash"><span class="hl-0">npm</span><span class="hl-1"> </span><span class="hl-2">install</span><span class="hl-1"> </span><span class="hl-2">@vvlad1973/simple-logger</span>
-</code><button type="button">Copy</button></pre>
-
-<a id="features" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Features<a href="#features" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><ul>
-<li>Supports logging at different levels: TRACE, DEBUG, INFO, WARN, ERROR, FATAL.</li>
-<li>Allows integration with external logging libraries like Pino.</li>
-</ul>
-<a id="usage" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Usage<a href="#usage" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><a id="simple-logger" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Simple Logger<a href="#simple-logger" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3><pre><code class="javascript"><br/><span class="hl-3">import</span><span class="hl-1"> </span><span class="hl-4">SimpleLogger</span><span class="hl-1"> </span><span class="hl-3">from</span><span class="hl-1"> </span><span class="hl-2">&#39;@vvlad1973/simple-logger&#39;</span><span class="hl-1">;</span><br/><br/><span class="hl-5">const</span><span class="hl-1"> </span><span class="hl-6">logger</span><span class="hl-1"> = </span><span class="hl-5">new</span><span class="hl-1"> </span><span class="hl-0">SimpleLogger</span><span class="hl-1">(</span><span class="hl-2">&#39;DEBUG&#39;</span><span class="hl-1">);</span><br/><br/><span class="hl-4">logger</span><span class="hl-1">.</span><span class="hl-0">debug</span><span class="hl-1">(</span><span class="hl-2">&#39;Debug message&#39;</span><span class="hl-1">);</span><br/><span class="hl-4">logger</span><span class="hl-1">.</span><span class="hl-0">info</span><span class="hl-1">(</span><span class="hl-2">&#39;Info message&#39;</span><span class="hl-1">);</span><br/><span class="hl-4">logger</span><span class="hl-1">.</span><span class="hl-0">warn</span><span class="hl-1">(</span><span class="hl-2">&#39;Warning message&#39;</span><span class="hl-1">);</span><br/><span class="hl-4">logger</span><span class="hl-1">.</span><span class="hl-0">error</span><span class="hl-1">(</span><span class="hl-2">&#39;Error message&#39;</span><span class="hl-1">);</span><br/><span class="hl-4">logger</span><span class="hl-1">.</span><span class="hl-0">fatal</span><span class="hl-1">(</span><span class="hl-2">&#39;Fatal error message&#39;</span><span class="hl-1">);</span>
-</code><button type="button">Copy</button></pre>
-
-<a id="integration-with-pino" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Integration with Pino<a href="#integration-with-pino" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3><pre><code class="javascript"><span class="hl-3">import</span><span class="hl-1"> </span><span class="hl-4">pino</span><span class="hl-1"> </span><span class="hl-3">from</span><span class="hl-1"> </span><span class="hl-2">&#39;pino&#39;</span><span class="hl-1">;</span><br/><span class="hl-3">import</span><span class="hl-1"> </span><span class="hl-4">SimpleLogger</span><span class="hl-1"> </span><span class="hl-3">from</span><span class="hl-1"> </span><span class="hl-2">&#39;@vvlad1973/simple-logger&#39;</span><span class="hl-1">;</span><br/><br/><span class="hl-7">// Initialize Pino logger</span><br/><span class="hl-5">const</span><span class="hl-1"> </span><span class="hl-6">pinoLogger</span><span class="hl-1"> = </span><span class="hl-0">pino</span><span class="hl-1">({</span><br/><span class="hl-1">  </span><span class="hl-4">prettyPrint:</span><span class="hl-1"> </span><span class="hl-5">true</span><span class="hl-1">,</span><br/><span class="hl-1">});</span><br/><br/><span class="hl-7">// Use Pino logger with SimpleLogger</span><br/><span class="hl-5">const</span><span class="hl-1"> </span><span class="hl-6">logger</span><span class="hl-1"> = </span><span class="hl-5">new</span><span class="hl-1"> </span><span class="hl-0">SimpleLogger</span><span class="hl-1">(</span><span class="hl-2">&#39;DEBUG&#39;</span><span class="hl-1">, </span><span class="hl-4">pinoLogger</span><span class="hl-1">);</span><br/><br/><span class="hl-4">logger</span><span class="hl-1">.</span><span class="hl-0">debug</span><span class="hl-1">(</span><span class="hl-2">&#39;Debug message&#39;</span><span class="hl-1">);</span><br/><span class="hl-4">logger</span><span class="hl-1">.</span><span class="hl-0">info</span><span class="hl-1">(</span><span class="hl-2">&#39;Info message&#39;</span><span class="hl-1">);</span><br/><span class="hl-4">logger</span><span class="hl-1">.</span><span class="hl-0">warn</span><span class="hl-1">(</span><span class="hl-2">&#39;Warning message&#39;</span><span class="hl-1">);</span><br/><span class="hl-4">logger</span><span class="hl-1">.</span><span class="hl-0">error</span><span class="hl-1">(</span><span class="hl-2">&#39;Error message&#39;</span><span class="hl-1">);</span><br/><span class="hl-4">logger</span><span class="hl-1">.</span><span class="hl-0">fatal</span><span class="hl-1">(</span><span class="hl-2">&#39;Fatal error message&#39;</span><span class="hl-1">);</span>
-</code><button type="button">Copy</button></pre>
-
-<a id="api" class="tsd-anchor"></a><h2 class="tsd-anchor-link">API<a href="#api" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><a id="new-simpleloggerlevel-externallogger" class="tsd-anchor"></a><h3 class="tsd-anchor-link">new SimpleLogger(level, externalLogger)<a href="#new-simpleloggerlevel-externallogger" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3><p>Creates a new instance of SimpleLogger.</p>
-<ul>
-<li>level (optional): Initial logging level. Defaults to 'INFO'.</li>
-<li>externalLogger (optional): External logger instance. Can be an object with methods (trace, debug, info, warn, error, fatal) or any other logger compatible with these methods.</li>
-</ul>
-<a id="setlevellevel" class="tsd-anchor"></a><h3 class="tsd-anchor-link">setLevel(level)<a href="#setlevellevel" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3><p>Sets the logging level of the logger instance.</p>
-<ul>
-<li>level: The logging level to set ('TRACE', 'DEBUG', 'INFO', 'WARN', 'ERROR', 'FATAL').</li>
-</ul>
-<a id="setexternalloggerlogger" class="tsd-anchor"></a><h3 class="tsd-anchor-link">setExternalLogger(logger)<a href="#setexternalloggerlogger" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3><p>Sets an external logger instance to be used by SimpleLogger.</p>
-<ul>
-<li>logger: External logger instance. Should be an object with methods (trace, debug, info, warn, error, fatal) or any other logger compatible with these methods.</li>
-</ul>
-<a id="logfunctionstartfunctionname" class="tsd-anchor"></a><h3 class="tsd-anchor-link">logFunctionStart(functionName?)<a href="#logfunctionstartfunctionname" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3><p>Logs the start of a function.</p>
-<ul>
-<li>functionName (optional): Name of the function to log. If not provided, attempts to retrieve the caller function name.</li>
-</ul>
-<a id="logfunctionendfunctionname" class="tsd-anchor"></a><h3 class="tsd-anchor-link">logFunctionEnd(functionName?)<a href="#logfunctionendfunctionname" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3><p>Logs the end of a function.</p>
-<ul>
-<li>functionName (optional): Name of the function to log. If not provided, attempts to retrieve the caller function name.</li>
-</ul>
-<a id="documentation" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Documentation<a href="#documentation" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3><p>Full information about the package is available in the <a href="media/index.html">./docs</a> directory</p>
-<a id="license" class="tsd-anchor"></a><h3 class="tsd-anchor-link">License<a href="#license" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3><p>This project is licensed under the MIT License with Commercial Use.</p>
-<a id="author" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Author<a href="#author" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><p>Vladislav Vnukovskiy <a href="mailto:vvlad1973@gmail.com">vvlad1973@gmail.com</a></p>
-</div></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#vvlad1973simple-logger"><span>@vvlad1973/simple-<wbr/>logger</span></a><ul><li><a href="#installation"><span>Installation</span></a></li><li><a href="#features"><span>Features</span></a></li><li><a href="#usage"><span>Usage</span></a></li><li><ul><li><a href="#simple-logger"><span>Simple <wbr/>Logger</span></a></li><li><a href="#integration-with-pino"><span>Integration with <wbr/>Pino</span></a></li></ul></li><li><a href="#api"><span>API</span></a></li><li><ul><li><a href="#new-simpleloggerlevel-externallogger"><span>new <wbr/>Simple<wbr/>Logger(level, external<wbr/>Logger)</span></a></li><li><a href="#setlevellevel"><span>set<wbr/>Level(level)</span></a></li><li><a href="#setexternalloggerlogger"><span>set<wbr/>External<wbr/>Logger(logger)</span></a></li><li><a href="#logfunctionstartfunctionname"><span>log<wbr/>Function<wbr/>Start(function<wbr/>Name?)</span></a></li><li><a href="#logfunctionendfunctionname"><span>log<wbr/>Function<wbr/>End(function<wbr/>Name?)</span></a></li><li><a href="#documentation"><span>Documentation</span></a></li><li><a href="#license"><span>License</span></a></li></ul></li><li><a href="#author"><span>Author</span></a></li></ul></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="modules.html">@vvlad1973/simple-logger - v1.2.1</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>

package/docs/types/ExternalLogger.html

@@ -1 +0,0 @@
-<!DOCTYPE html><html class="default" lang="en" data-base=".."><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>ExternalLogger | @vvlad1973/simple-logger - v1.2.1</title><meta name="description" content="Documentation for @vvlad1973/simple-logger"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search"><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@vvlad1973/simple-logger - v1.2.1</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">@vvlad1973/simple-logger</a></li><li><a href="ExternalLogger.html">ExternalLogger</a></li></ul><h1>Type Alias ExternalLogger</h1></div><div class="tsd-signature"><span class="tsd-kind-type-alias">ExternalLogger</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{</span><br/>    <span class="tsd-kind-property">debug</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">LogFn</span><span class="tsd-signature-symbol">;</span><br/>    <span class="tsd-kind-property">error</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">LogFn</span><span class="tsd-signature-symbol">;</span><br/>    <span class="tsd-kind-property">fatal</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">LogFn</span><span class="tsd-signature-symbol">;</span><br/>    <span class="tsd-kind-property">info</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">LogFn</span><span class="tsd-signature-symbol">;</span><br/>    <span class="tsd-kind-property">level</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/>    <span class="tsd-kind-property">silent</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">LogFn</span><span class="tsd-signature-symbol">;</span><br/>    <span class="tsd-kind-property">trace</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">LogFn</span><span class="tsd-signature-symbol">;</span><br/>    <span class="tsd-kind-property">warn</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">LogFn</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">debug</span><a id="__typedebug" class="tsd-anchor"></a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">LogFn</span></h5></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">error</span><a id="__typeerror" class="tsd-anchor"></a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">LogFn</span></h5></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">fatal</span><a id="__typefatal" class="tsd-anchor"></a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">LogFn</span></h5></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">info</span><a id="__typeinfo" class="tsd-anchor"></a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">LogFn</span></h5></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">level</span><a id="__typelevel" class="tsd-anchor"></a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">silent</span><a id="__typesilent" class="tsd-anchor"></a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">LogFn</span></h5></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">trace</span><a id="__typetrace" class="tsd-anchor"></a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">LogFn</span></h5></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">warn</span><a id="__typewarn" class="tsd-anchor"></a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">LogFn</span></h5></li></ul></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/vvlad1973/vvlad1973-simple-logger/blob/521c6e1ac04147bd4f4bd20eedb2287852cfe54d/src/simple-logger.ts#L8">simple-logger.ts:8</a></li></ul></aside></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">@vvlad1973/simple-logger - v1.2.1</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>

package/jsdoc.json

@@ -1,14 +0,0 @@
-{
-    "source": {
-      "include": ["./src/"],
-      "includePattern": "\\.(ts)$",
-      "excludePattern": "(^|\\/|\\\\)node_modules"
-    },
-    "plugins": ["node_modules/better-docs/typescript"],
-    "opts": {
-      "destination": "./docs",
-      "recurse": true,
-      "template": "node_modules/better-docs"
-    }
-  }
-  

package/src/simple-logger.ts

@@ -1,190 +0,0 @@
-/**
- * A module for simple logging with various logging levels.
- * @module SimpleLogger
- */
-
-import { getCallerName } from 'vvlad1973-utils';
-
-export type ExternalLogger = {
-  trace?: LogFn;
-  debug?: LogFn;
-  info?: LogFn;
-  warn?: LogFn;
-  error?: LogFn;
-  fatal?: LogFn;
-  silent?: LogFn;
-  level?: string;
-};
-
-interface LogFn {
-  <T extends object>(obj: T, msg?: string, ...args: any[]): void;
-  (obj: unknown, msg?: string, ...args: any[]): void;
-  (msg: string, ...args: any[]): void;
-}
-
-const loggerLevels = [
-  'trace',
-  'debug',
-  'info',
-  'warn',
-  'error',
-  'fatal',
-  'silent',
-] as const;
-
-export type LoggerLevel = (typeof loggerLevels)[number];
-/**
- * A simple logger class with various logging levels.
- * @class
- * @param {string} [level='info'] - Initial logging level.
- * @param {ExternalLogger | undefined | null} [externalLogger=null] - Optional external logger to use.
- */
-export class SimpleLogger {
-  #levels = loggerLevels;
-  #currentLevel: number = 2;
-  #logger: ExternalLogger | Console = console;
-
-  isExternal: boolean = false;
-
-  constructor(level?: LoggerLevel, externalLogger?: ExternalLogger) {
-    if (externalLogger && this.isValidLogger(externalLogger)) {
-      this.setExternalLogger(externalLogger, level);
-    } else {
-      this.setLevel(level ?? 'info');
-    }
-  }
-
-  trace: LogFn = (...args: any[]) => {};
-  debug: LogFn = (...args: any[]) => {};
-  info: LogFn = (...args: any[]) => {};
-  warn: LogFn = (...args: any[]) => {};
-  error: LogFn = (...args: any[]) => {};
-  fatal: LogFn = (...args: any[]) => {};
-  silent: LogFn = (...args: any[]) => {};
-
-  private static readonly noop: LogFn = (...args: any[]) => {};
-
-  /**
-   * Updates the logging methods based on the current logging level.
-   * @private
-   */
-  private updateLoggingMethods() {
-    try {
-      this.#levels.forEach((level, index) => {
-        this[level] =
-          this.#currentLevel <= index
-            ? this.getExternalLoggerMethod(
-                level,
-                level === 'fatal' ? 'error' : undefined
-              )
-            : SimpleLogger.noop;
-      });
-    } catch (error) {
-      console.error(error);
-    }
-  }
-
-  /**
-   * Checks if the provided logger is valid.
-   * @private
-   * @param {any} logger - The logger to check.
-   * @returns {boolean} - True if the logger is valid, otherwise false.
-   */
-  private isValidLogger(logger: any): boolean {
-    return (
-      typeof logger === 'object' &&
-      logger !== null &&
-      loggerLevels.some((level) => typeof logger[level] === 'function')
-    );
-  }
-
-  /**
-   * Gets the external logger method for a specific level.
-   * @param {string} method - The logger method to get.
-   * @param {string} [fallbackMethod] - The fallback logger method to get.
-   * @returns {LogFn} - The logger method or a no-op function.
-   * @private
-   */
-  private getExternalLoggerMethod(
-    method: keyof ExternalLogger,
-    fallbackMethod?: keyof ExternalLogger
-  ): LogFn {
-    try {
-      const loggerMethod = (this.#logger as ExternalLogger)[method];
-
-      if (typeof loggerMethod === 'function') {
-        return loggerMethod.bind(this.#logger);
-      } else if (typeof fallbackMethod !== 'undefined') {
-        const fallbackLoggerMethod = (this.#logger as ExternalLogger)[
-          fallbackMethod
-        ];
-
-        if (typeof fallbackLoggerMethod === 'function') {
-          return fallbackLoggerMethod.bind(this.#logger);
-        }
-      }
-      return SimpleLogger.noop;
-    } catch (error) {
-      console.error(error);
-      return SimpleLogger.noop;
-    }
-  }
-
-  /**
-   * Sets the logging level.
-   * @param {string} level - The logging level to set.
-   */
-  public setLevel(level: string) {
-    const index = this.#levels.indexOf(level.toLowerCase() as LoggerLevel);
-    if (index !== -1) {
-      this.#currentLevel = index;
-
-      if (typeof (this.#logger as ExternalLogger).level === 'string') {
-        (this.#logger as ExternalLogger).level = level;
-      }
-      this.updateLoggingMethods();
-    }
-  }
-
-  /**
-   * Sets an external logger to be used.
-   * @param {ExternalLogger | undefined | null} logger - The external logger to set.
-   */
-  public setExternalLogger(
-    logger: ExternalLogger | undefined | null,
-    level?: LoggerLevel
-  ) {
-    if (logger && this.isValidLogger(logger)) {
-      this.#logger = logger;
-      this.isExternal = true;
-    } else {
-      this.#logger = console;
-      this.isExternal = false;
-    }
-    this.setLevel(
-      level ??
-        (logger?.level as LoggerLevel) ??
-        this.#levels[this.#currentLevel]
-    );
-  }
-
-  /**
-   * Logs the start of a function.
-   * @param {string} [functionName] - Optional function name to log.
-   */
-  public logFunctionStart(functionName?: string) {
-    const callerName = functionName || getCallerName();
-    this.trace(`Function start: ${callerName}`);
-  }
-
-  /**
-   * Logs the end of a function.
-   * @param {string} [functionName] - Optional function name to log.
-   */
-  public logFunctionEnd(functionName?: string) {
-    const callerName = functionName || getCallerName();
-    this.trace(`Function end: ${callerName}`);
-  }
-}
-
-export default SimpleLogger;