docs(logger): describe defaults

Author: mumenthalers

libs/core/src/lib/logger/browser-console/with-browser-console-transport.function.ts

@@ -1,5 +1,6 @@
 import { LogTransport } from '@shiftcode/logger'
 
+import { ValueOrFactory } from '../helper/value-or-factory.type'
 import { LoggerFeature } from '../logger-feature.type'
 import { LoggerFeatureKind } from '../logger-feature-kind.enum'
 import {
@@ -8,18 +9,15 @@ import {
   BrowserConsoleLogTransportService,
 } from './browser-console-log-transport.service'
 
-export function withBrowserConsoleTransport(
-  browserConsoleLogTransportConfigOrFactory:
-    | BrowserConsoleLogTransportConfig
-    | (() => BrowserConsoleLogTransportConfig),
-): LoggerFeature {
-  const configProvider =
-    typeof browserConsoleLogTransportConfigOrFactory === 'function'
-      ? { provide: BROWSER_CONSOLE_LOG_TRANSPORT_CONFIG, useFactory: browserConsoleLogTransportConfigOrFactory }
-      : { provide: BROWSER_CONSOLE_LOG_TRANSPORT_CONFIG, useValue: browserConsoleLogTransportConfigOrFactory }
-
+export function withBrowserConsoleTransport(config: ValueOrFactory<BrowserConsoleLogTransportConfig>): LoggerFeature {
   return {
     kind: LoggerFeatureKind.TRANSPORT,
-    providers: [configProvider, { provide: LogTransport, useClass: BrowserConsoleLogTransportService, multi: true }],
+    providers: [
+      {
+        provide: BROWSER_CONSOLE_LOG_TRANSPORT_CONFIG,
+        ...(typeof config === 'function' ? { useFactory: config } : { useValue: config }),
+      },
+      { provide: LogTransport, useClass: BrowserConsoleLogTransportService, multi: true },
+    ],
   }
 }

libs/core/src/lib/logger/cloud-watch-log/cloud-watch-log-config.injection-token.ts

@@ -3,13 +3,25 @@ import { LogLevel } from '@shiftcode/logger'
 
 export interface CloudWatchLogV2Config {
   logLevel: LogLevel
+
+  /**
+   * the url of the CloudWatchApi Construct from @shiftcode/cdk-utils
+   */
   apiUrl: string
 
   /** milliseconds until logs are flushed to aws */
   flushInterval: number
+
+  /**
+   * replacer function for JSON.stringify
+   * @default {@link jsonMapSetStringifyReplacer}
+   */
   jsonStringifyReplacer?: (key: string, value: any) => any
 
-  /** max number of sub-threshold log events to buffer before dropping oldest. default 100 */
+  /**
+   * max number of sub-threshold log events to buffer before dropping oldest.
+   * @default 100
+   */
   bufferSize?: number
 }
 

libs/core/src/lib/logger/cloud-watch-log/cloud-watch-log-transport.service.ts

@@ -18,7 +18,9 @@ export class CloudWatchLogV2TransportService extends LogTransport {
   }
 
   log(level: LogLevel, clazzName: string, _color: string, timestamp: Date, args: unknown[]): void {
-    // checking the log level is done in the cloudWatchLogger. important.
+    /**
+     * checking the log level is done in the {@link CloudWatchLogV2Service} in order to do the buffering of below-level logs.
+     */
     this.cloudWatchLogger.addMessage(level, clazzName, timestamp, args)
   }
 }

libs/core/src/lib/logger/console-json/with-console-json-log-transport.function.ts

@@ -9,17 +9,13 @@ import {
   ConsoleJsonLogTransportService,
 } from './console-json-log-transport.service'
 
-export function withConsoleJsonLogTransport(
-  consoleJsonLogTransportConfig: ValueOrFactory<ConsoleJsonLogTransportConfig>,
-): LoggerFeature {
+export function withConsoleJsonLogTransport(config: ValueOrFactory<ConsoleJsonLogTransportConfig>): LoggerFeature {
   return {
     kind: LoggerFeatureKind.TRANSPORT,
     providers: [
       {
         provide: CONSOLE_JSON_LOG_TRANSPORT_CONFIG,
-        ...(typeof consoleJsonLogTransportConfig === 'function'
-          ? { useFactory: consoleJsonLogTransportConfig }
-          : { useValue: consoleJsonLogTransportConfig }),
+        ...(typeof config === 'function' ? { useFactory: config } : { useValue: config }),
       },
       { provide: LogTransport, useClass: ConsoleJsonLogTransportService, multi: true },
     ],

libs/core/src/lib/logger/node-console/node-console-log-transport.service.ts

@@ -40,44 +40,46 @@ export class NodeConsoleLogTransportService extends LogTransport {
 
   log(level: LogLevel, clazzName: string, hexColor: string, timestamp: Date, args: any[]) {
     if (this.isLevelEnabled(level)) {
-      const now = loggingTimeFormat.format(timestamp)
-      // make sure to not alter the input args array
-      if (typeof args[0] === 'string') {
-        // if first arg is string, also colorize it
-        args = [
-          logLevelEmoji[level],
-          colorizeForConsole(`${now} - ${clazzName} :: ${args[0]}`, hexColor),
-          ...args.slice(1).map(this.stringifyJson),
-        ]
-      } else {
-        args = [
-          logLevelEmoji[level],
-          colorizeForConsole(`${now} - ${clazzName} ::`, hexColor),
-          ...args.map(this.stringifyJson),
-        ]
-      }
+      return
+    }
 
-      /* eslint-disable no-console */
-      switch (level) {
-        case LogLevel.DEBUG:
-          console.debug(...args)
-          break
-        case LogLevel.ERROR:
-          console.error(...args)
-          break
-        case LogLevel.INFO:
-          console.info(...args)
-          break
-        case LogLevel.WARN:
-          console.warn(...args)
-          break
-        case LogLevel.OFF:
-          break
-        default:
-          return level // exhaustive check
-      }
-      /* eslint-enable no-console */
+    const now = loggingTimeFormat.format(timestamp)
+    // make sure to not alter the input args array
+    if (typeof args[0] === 'string') {
+      // if first arg is string, also colorize it
+      args = [
+        logLevelEmoji[level],
+        colorizeForConsole(`${now} - ${clazzName} :: ${args[0]}`, hexColor),
+        ...args.slice(1).map(this.stringifyJson),
+      ]
+    } else {
+      args = [
+        logLevelEmoji[level],
+        colorizeForConsole(`${now} - ${clazzName} ::`, hexColor),
+        ...args.map(this.stringifyJson),
+      ]
+    }
+
+    /* eslint-disable no-console */
+    switch (level) {
+      case LogLevel.DEBUG:
+        console.debug(...args)
+        break
+      case LogLevel.ERROR:
+        console.error(...args)
+        break
+      case LogLevel.INFO:
+        console.info(...args)
+        break
+      case LogLevel.WARN:
+        console.warn(...args)
+        break
+      case LogLevel.OFF:
+        break
+      default:
+        return level // exhaustive check
     }
+    /* eslint-enable no-console */
   }
 
   private readonly stringifyJson = (data: unknown) => {

libs/core/src/lib/logger/node-console/with-node-console-transport.function.ts

@@ -5,15 +5,13 @@ import { LoggerFeature } from '../logger-feature.type'
 import { LoggerFeatureKind } from '../logger-feature-kind.enum'
 import { NODE_CONSOLE_LOG_TRANSPORT_CONFIG, NodeConsoleLogTransportService } from './node-console-log-transport.service'
 
-export function withNodeConsoleTransport(nodeConsoleLogTransportConfig: ValueOrFactory<any>): LoggerFeature {
+export function withNodeConsoleTransport(config: ValueOrFactory<any>): LoggerFeature {
   return {
     kind: LoggerFeatureKind.TRANSPORT,
     providers: [
       {
         provide: NODE_CONSOLE_LOG_TRANSPORT_CONFIG,
-        ...(typeof nodeConsoleLogTransportConfig === 'function'
-          ? { useFactory: nodeConsoleLogTransportConfig }
-          : { useValue: nodeConsoleLogTransportConfig }),
+        ...(typeof config === 'function' ? { useFactory: config } : { useValue: config }),
       },
       { provide: LogTransport, useClass: NodeConsoleLogTransportService, multi: true },
     ],