Add 类型注释文件

README.md

@@ -102,7 +102,7 @@ rlog.toolkit.methodName();
 
 Toolkit是一个工具类，用于提供一些常用的工具函数。它具有以下方法：
 
-- `checkLogFile(path, rlog)`：检查日志文件是否存在，如果不存在则创建该文件。
+- `checkLogFile(path)`：检查日志文件是否存在，如果不存在则创建该文件。
 - `colorizeString(str)`：根据配置的颜色规则对字符串进行着色。
 - `formatTime()`：根据配置的时间格式和时区生成时间字符串。
 - `encryptPrivacyContent(str)`：对字符串中的敏感内容进行加密。

index.d.ts

@@ -0,0 +1,74 @@
+/**
+ * rlog-js
+ * @license MIT
+ */
+declare namespace Rlog {
+  interface CustomColorRule {
+    reg: string;
+    color: string;
+  }
+
+  class Config {
+    enableColorfulOutput: boolean;
+    logFilePath?: string;
+    timeFormat: string;
+    timezone: string;
+    blockedWordsList: string[];
+    customColorRules: CustomColorRule[];
+    setConfig(obj?: Partial<Config>): void;
+    setConfigGlobal(obj?: Partial<Config>): void;
+  }
+
+  class Toolkit {
+    constructor(config: Config);
+    config: Config;
+    screen: Screen;
+    checkLogFile(path: string): Promise<void>;
+    colorizeString(str: string): string;
+    formatTime(): string;
+    encryptPrivacyContent(str: string): string;
+    colorizeType(variable: any): string;
+    padLines(str: string, width: number): string;
+  }
+
+  class Screen {
+    constructor(toolkit: Toolkit);
+    toolkit: Toolkit;
+    info(message: any, time?: string): void;
+    warning(message: any, time?: string): void;
+    error(message: any, time?: string): void;
+    success(message: any, time?: string): void;
+    exit(message: any, time?: string): void;
+  }
+
+  class File {
+    constructor(toolkit: Toolkit, config: Config, screen: Screen);
+    config: Config;
+    toolkit: Toolkit;
+    screen: Screen;
+    logStream: NodeJS.WriteStream;
+    init(): void;
+    writeLogToStream(text: string): Promise<void>;
+    wirteLog(text: string): void;
+    info(message: any, time?: string): void;
+    warning(message: any, time?: string): void;
+    error(message: any, time?: string): void;
+    success(message: any, time?: string): void;
+    exit(message: any, time?: string): void;
+  }
+}
+declare class Rlog {
+  constructor(config?: Rlog.Config);
+  config: Rlog.Config;
+  toolkit: Rlog.Toolkit;
+  screen: Screen;
+  file: File;
+  info(message: any): void;
+  warning(message: any): void;
+  error(message: any): void;
+  success(message: any): void;
+  exit(message: any): Promise<never>;
+  log(message: any): void;
+}
+
+export = Rlog;

index.js

@@ -72,7 +72,7 @@ class Toolkit {
   config = null;
   /**@type {Screen} */
   screen = null;
-  async checkLogFile(path, rlog) {
+  async checkLogFile(path) {
     try {
       await fs.promises.access(path, fs.constants.F_OK);
     } catch (err) {

package.json

@@ -24,6 +24,7 @@
   },
   "homepage": "https://github.com/RavelloH/RLog#readme",
   "dependencies": {
+    "@types/node": "",
     "chalk": "^4.1.2",
     "moment": "^2.29.4",
     "moment-timezone": "^0.5.43"