fix(node): ProcLog types

Author: commenthol

src/LogBase.js

@@ -14,7 +14,8 @@ const time = {
 
 /**
  * @typedef {import('./utils.js').Level} Level
- *
+ */
+/**
  * @typedef {object} ExtLogBaseOptions
  * @property {Level} [level] log level
  * @property {string} [namespaces] namespaces for logging
@@ -25,7 +26,8 @@ const time = {
  * @property {number} [spaces] number of spaces for pretty print JSON
  * @property {boolean} [splitLine] split lines for pretty "debug" like output (not recommended for prod use)
  * @property {object} [serializers] serializers to be applied on object properties
- *
+ */
+/**
  * @typedef {import('./Format.js').FormatOption} FormatOption
  * @typedef {FormatOption & ExtLogBaseOptions} LogBaseOptions
  */

src/ProcLog.js

@@ -2,11 +2,13 @@ import { LogBase } from './LogBase.js'
 import { Log } from './node.js'
 import { inspectOpts, inspectNamespaces, INFO } from './utils.js'
 
+/** @typedef {import('./utils.js').Level} Level */
+/** @typedef {import('./node.js').LogOptions} LogOptions */
+/** @typedef {LogOptions & {Log: typeof Log}} LogOptionsWithCustomLog */
 /**
- * @typedef {import('./node.js').LogOptions} LogOptions
- */
-/**
- * @typedef {LogOptions & {Log: typeof Log}} LogOptionsWithCustomLog
+ * @typedef {object} ProcLogOptions
+ * @property {Level} [level] log level
+ * @property {string} [namespaces] namespaces for logging
  */
 
 export const EVENT_NAME = 'log-level'
@@ -50,8 +52,8 @@ const defaultOptions = {
 export class ProcLog extends LogBase {
   /**
    * creates a new logger
-   * @param {String} name - namespace of Logger
-   * @param {LogOptions} [opts] - see Log.options
+   * @param {string} name - namespace of Logger
+   * @param {ProcLogOptions} [opts] - see Log.options
    */
   constructor(name, opts) {
     const _opts = {

src/index.js

@@ -2,6 +2,7 @@
 /** @typedef {import('./node.js').LogOptions & {Log: typeof Log}} LogOptions */
 /** @typedef {import('./node.js').LogOptionWrapConsole} LogOptionWrapConsole */
 /** @typedef {import('./node.js').LogOptionHandleExitEvents} LogOptionHandleExitEvents */
+/** @typedef {import('./ProcLog.js').ProcLogOptions} ProcLogOptions */
 /** @typedef {import('./ecs/LogEcs.js').LogOptionsEcs} LogOptionsEcs */
 /** @typedef {import('./browserLogs.js').MwLogOption} MwLogOption */
 /** @typedef {import('./httpLogs.js').LogOptionsHttpLog} LogOptionsHttpLog */

types/LogBase.d.ts

@@ -1,6 +1,7 @@
 /**
  * @typedef {import('./utils.js').Level} Level
- *
+ */
+/**
  * @typedef {object} ExtLogBaseOptions
  * @property {Level} [level] log level
  * @property {string} [namespaces] namespaces for logging
@@ -11,7 +12,8 @@
  * @property {number} [spaces] number of spaces for pretty print JSON
  * @property {boolean} [splitLine] split lines for pretty "debug" like output (not recommended for prod use)
  * @property {object} [serializers] serializers to be applied on object properties
- *
+ */
+/**
  * @typedef {import('./Format.js').FormatOption} FormatOption
  * @typedef {FormatOption & ExtLogBaseOptions} LogBaseOptions
  */

types/ProcLog.d.ts

@@ -3,11 +3,13 @@
  * @param {LogOptionsWithCustomLog} [options]
  */
 export function initProcLog(options?: LogOptionsWithCustomLog): void;
+/** @typedef {import('./utils.js').Level} Level */
+/** @typedef {import('./node.js').LogOptions} LogOptions */
+/** @typedef {LogOptions & {Log: typeof Log}} LogOptionsWithCustomLog */
 /**
- * @typedef {import('./node.js').LogOptions} LogOptions
- */
-/**
- * @typedef {LogOptions & {Log: typeof Log}} LogOptionsWithCustomLog
+ * @typedef {object} ProcLogOptions
+ * @property {Level} [level] log level
+ * @property {string} [namespaces] namespaces for logging
  */
 export const EVENT_NAME: "log-level";
 /**
@@ -44,14 +46,25 @@ export const EVENT_NAME: "log-level";
 export class ProcLog extends LogBase {
     /**
      * creates a new logger
-     * @param {String} name - namespace of Logger
-     * @param {LogOptions} [opts] - see Log.options
+     * @param {string} name - namespace of Logger
+     * @param {ProcLogOptions} [opts] - see Log.options
      */
-    constructor(name: string, opts?: LogOptions);
+    constructor(name: string, opts?: ProcLogOptions);
 }
+export type Level = import("./utils.js").Level;
 export type LogOptions = import("./node.js").LogOptions;
 export type LogOptionsWithCustomLog = LogOptions & {
     Log: typeof Log;
 };
+export type ProcLogOptions = {
+    /**
+     * log level
+     */
+    level?: import("./utils.js").Level | undefined;
+    /**
+     * namespaces for logging
+     */
+    namespaces?: string | undefined;
+};
 import { LogBase } from './LogBase.js';
 import { Log } from './node.js';

types/index.d.ts

@@ -5,6 +5,7 @@ export type LogOptions = import("./node.js").LogOptions & {
 };
 export type LogOptionWrapConsole = import("./node.js").LogOptionWrapConsole;
 export type LogOptionHandleExitEvents = import("./node.js").LogOptionHandleExitEvents;
+export type ProcLogOptions = import("./ProcLog.js").ProcLogOptions;
 export type LogOptionsEcs = import("./ecs/LogEcs.js").LogOptionsEcs;
 export type MwLogOption = import("./browserLogs.js").MwLogOption;
 export type LogOptionsHttpLog = import("./httpLogs.js").LogOptionsHttpLog;