fix types

moleculerjs · Nov 26, 2023 · f6d97ff · f6d97ff
1 parent 696e451
commit f6d97ff
Show file tree

Hide file tree

Showing 8 changed files with 17 additions and 20 deletions.
diff --git a/src/loggers/base.d.ts b/src/loggers/base.d.ts
@@ -18,13 +18,13 @@ declare abstract class BaseLogger {
     loggerFactory: LoggerFactory;
     broker: ServiceBroker;
 
-	opts: BaseLogger.LoggerOptions
+	// opts: BaseLogger.LoggerOptions
 
 	init(loggerFactory: LoggerFactory): void;
 
 	stop(): void;
 
-	getLogLevels(mod: string): BaseLogger.LogLevels | null;
+	getLogLevel(mod: string): BaseLogger.LogLevels | null;
 
 	getLogHandler(bindings: LoggerFactory.LoggerBindings): BaseLogger.LogHandler | null;
 

diff --git a/src/loggers/bunyan.d.ts b/src/loggers/bunyan.d.ts
@@ -3,13 +3,12 @@ import LoggerFactory = require("../logger-factory");
 import BaseLogger = require("./base");
 import type { LoggerOptions } from "./base";
 
+import type { LoggerOptions as BunyanNativeLoggerOptions } from "bunyan";
+
 declare namespace BunyanLogger {
 
 	export interface BunyanLoggerOptions extends LoggerOptions {
-		bunyan?: {
-			name?: string,
-			[key: string]: any
-		}
+		bunyan?: BunyanNativeLoggerOptions
 	}
 }
 

diff --git a/src/loggers/file.js b/src/loggers/file.js
@@ -9,14 +9,11 @@
 const FormattedLogger = require("./formatted");
 const _ = require("lodash");
 
-const fs = require("fs");
+const fs = require("fs").promises;
 const path = require("path");
 const os = require("os");
-const util = require("util");
 const { makeDirs } = require("../utils");
 
-const appendFile = util.promisify(fs.appendFile);
-
 /**
  * Import types
  *
@@ -41,10 +38,7 @@ class FileLogger extends FormattedLogger {
 	constructor(opts) {
 		super(opts);
 
-		/**
-		 * @type {FileLoggerOptions}
-		 * @override
-		 */
+		/** @type {FileLoggerOptions} */
 		this.opts = _.defaultsDeep(this.opts, {
 			folder: "./logs",
 			filename: "moleculer-{date}.log",
@@ -157,7 +151,7 @@ class FileLogger extends FormattedLogger {
 
 			const buf = rows.join(this.opts.eol) + this.opts.eol;
 
-			return appendFile(filename, buf).catch(err => {
+			return fs.appendFile(filename, buf).catch(err => {
 				/* istanbul ignore next */
 				console.debug("Unable to write log file:", filename, err); // eslint-disable-line no-console
 			});

diff --git a/src/loggers/formatted.d.ts b/src/loggers/formatted.d.ts
@@ -5,7 +5,7 @@ import type { LoggerOptions } from "./base";
 
 declare namespace FormattedLogger {
 
-	export type FormatterFunction = (obj: any) => string;
+	export type FormatterFunction = (type: string, args: any[]) => string[];
 
 	export interface FormattedLoggerOptions extends LoggerOptions {
 		colors?: boolean,
@@ -19,10 +19,12 @@ declare namespace FormattedLogger {
 declare class FormattedLogger extends BaseLogger {
 	constructor(opts?: FormattedLogger.FormattedLoggerOptions);
 
-	opts: FormattedLogger.FormattedLoggerOptions;
+	// opts: FormattedLogger.FormattedLoggerOptions;
 
 	init(loggerFactory: LoggerFactory): void;
 	getLogHandler(bindings: LoggerFactory.LoggerBindings): BaseLogger.LogHandler | null;
+	getFormatter(bindings: LoggerFactory.LoggerBindings) : FormattedLogger.FormatterFunction;
+	render(str: string, obj: Record<string, any>): string;
 }
 
 export = FormattedLogger;
diff --git a/src/loggers/log4js.d.ts b/src/loggers/log4js.d.ts
@@ -2,11 +2,12 @@ import LoggerFactory = require("../logger-factory");
 
 import BaseLogger = require("./base");
 import type { LoggerOptions } from "./base";
+import type { Configuration } from "log4js";
 
 declare namespace Log4jsLogger {
 
 	export interface Log4jsLoggerOptions extends LoggerOptions {
-		log4js?: Record<string, any>
+		log4js?: Configuration
 	}
 }
 

diff --git a/src/middlewares/transmit/compression.js b/src/middlewares/transmit/compression.js
@@ -15,6 +15,7 @@ const { promisify } = require("util");
  * This is a transmission compression middleware. It supports
  * the `deflate`, `deflateRaw` & `gzip` compression methods.
  *
+ * @param {object} opts
  * @param {String?} opts.method
  * @param {String|Number} opts.threshold
  */

diff --git a/src/utils.d.ts b/src/utils.d.ts
@@ -40,7 +40,7 @@ export declare function dotSet<T extends object>(obj: T, path: string, value: un
 
 export declare function makeDirs(path: string): void;
 
-export declare function parseByteString(value: string): number;
+export declare function parseByteString(value: string|number): number;
 
 export declare function uniq(arr: Array<String|Number>): Array<String|Number>;
 

diff --git a/src/utils.js b/src/utils.js
@@ -431,7 +431,7 @@ const utils = {
 	 * Parse a byte string to number of bytes. E.g "1kb" -> 1024
 	 * Credits: https://github.com/visionmedia/bytes.js
 	 *
-	 * @param {String} v
+	 * @param {String|number} v
 	 * @returns {Number|null}
 	 */
 	parseByteString(v) {