@wlix/logger 1.0.0 → 1.0.2

package/README.md

@@ -4,23 +4,31 @@ A tiny file-based logger for Node.js projects. It writes logs to daily files and
 
 ## How it works
 
--   When you create a `Logger`, it ensures the logs directory exists.
--   Each day gets its own log file named `DD-MM-YYYY.log`.
--   Every log line includes UTC time, log level, and your message.
--   Logs are then written to the file automatically.
+-   When you create a logger instance, it makes sure the logs directory exists.
+-   Each calendar day gets its own log file named `DD-MM-YYYY.log`.
+-   Every log line has UTC time (or UTC offset), log type (info, warn, or error), and message.
+-   Logs are then written to the appropriate log file.
 
 ## Usage
 
--   Instantiate a new Logger instance.
--   Use `Logger#info()`, `Logger#warn()`, or `Logger#error()` with a message.
+-   Use `createLogger()` to create a new logger.
+-   Use the returned function with `"info" | "warn" | "error"` and your message.
 -   Files are written to the `./logs` dir by default.
 
 ```ts
-import { Logger } from "./Logger";
+import { createLogger } from "./Logger";
 
-const logger = new Logger({ logToStdout: true });
+const logger = createLogger();
 
-logger.info("Connected to server");
-logger.warn("Memory is low");
-logger.error("Something went wrong");
+logger("info", "Connected to server");
+logger("warn", "Memory is low");
+logger("error", "Something went wrong");
 ```
+
+## Configuration
+
+| Option        | Type                    | Default    | Description                                                      |
+| ------------- | ----------------------- | ---------- | ---------------------------------------------------------------- |
+| `logsPath`    | `string`                | `"./logs"` | Path of the directory where log files are stored                 |
+| `logToStdout` | `boolean`               | `true`     | Whether to print logs to the console                             |
+| `timezone`    | `"UTC"` \| `UTC±number` | `"UTC"`    | Timezone for log timestamps, e.g., `"UTC"`, `"UTC+3"`, `"UTC-6"` |

package/index.d.ts

@@ -28,6 +28,6 @@ export interface LoggerConfig {
  * @param config Optional logger configuration.
  * @returns A function to log messages: log(type, message)
  */
-export declare function Logger(
+export declare function createLogger(
     config?: LoggerConfig
 ): (type: "info" | "warn" | "error", message: string) => void;

package/index.js

@@ -14,7 +14,7 @@ const { join } = require("path");
  * @param {LoggerConfig} config Optional logger configuration.
  * @returns {(type: "info" | "warn" | "error", message: string) => void} Function to log messages
  */
-function Logger(config = {}) {
+function createLogger(config = {}) {
     const logsPath = config.logsPath ?? "./logs";
     const logToStdout = config.logToStdout ?? true;
     const timezone = config.timezone ?? "UTC";
@@ -73,4 +73,4 @@ function Logger(config = {}) {
     return log;
 }
 
-module.exports = { Logger };
+module.exports = { Logger: createLogger };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wlix/logger",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "description": "A simple logger.",
   "main": "index.js",
   "types": "index.d.ts",
@@ -14,7 +14,7 @@
     "access": "public"
   },
   "author": "wlix",
-  "license": "ISC",
+  "license": "MIT",
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1"
   }