@tmlmobilidade/utils 20250901.2024.56 → 20250901.2033.7

package/dist/src/logs/logs.d.ts

@@ -12,20 +12,19 @@ interface LogColumn {
      */
     txt: string;
 }
-/**
- * Logger class for structured logging.
- */
-export declare class Logs {
+declare class LogsClass {
     /**
      * Logs a divider line in the console.
      * @param message Optional message to display.
-     * @param size Width of the divider line.
+     * @param size Width of the divider line. Default is `75`.
      */
     divider(message?: string, size?: number): void;
     /**
      * Logs an error message in the console.
      * @param message Error message to display.
      * @param error Optional error object to display.
+     * @param spacesAfter Optional number of blank lines to add after the message.
+     * @param spacesBefore Optional number of blank lines to add before the message.
      */
     error(message: string, error?: Error, spacesAfter?: number, spacesBefore?: number): void;
     /**
@@ -48,9 +47,9 @@ export declare class Logs {
     progress(message: LogColumn[] | string, spacesAfter?: number, spacesBefore?: number): void;
     /**
      * Logs a spacer line in the console.
-     * @param lines Number of blank lines to add.
+     * @param lines Number of blank lines to add. Default is `1`.
      */
-    spacer(lines: number): void;
+    spacer(lines?: number): void;
     /**
      * Logs a success message in the console.
      * @param message Success message to display.
@@ -68,6 +67,15 @@ export declare class Logs {
      * @param message Title message to display.
      */
     title(message: string): void;
+    /**
+     * Formats an array of log columns or strings into a single string.
+     * @param columns Array of log columns or strings to format.
+     * @returns Formatted string.
+     */
     private formatColumns;
 }
+/**
+ * Logger class for structured logging.
+ */
+export declare const Logs: LogsClass;
 export {};

package/dist/src/logs/logs.js

@@ -1,13 +1,11 @@
 /* * */
-/**
- * Logger class for structured logging.
- */
-export class Logs {
+/* * */
+class LogsClass {
     //
     /**
      * Logs a divider line in the console.
      * @param message Optional message to display.
-     * @param size Width of the divider line.
+     * @param size Width of the divider line. Default is `75`.
      */
     divider(message, size = 75) {
         console.log();
@@ -21,6 +19,8 @@ export class Logs {
      * Logs an error message in the console.
      * @param message Error message to display.
      * @param error Optional error object to display.
+     * @param spacesAfter Optional number of blank lines to add after the message.
+     * @param spacesBefore Optional number of blank lines to add before the message.
      */
     error(message, error, spacesAfter, spacesBefore) {
         if (spacesBefore && spacesBefore > 0)
@@ -77,9 +77,9 @@ export class Logs {
     }
     /**
      * Logs a spacer line in the console.
-     * @param lines Number of blank lines to add.
+     * @param lines Number of blank lines to add. Default is `1`.
      */
-    spacer(lines) {
+    spacer(lines = 1) {
         for (let i = 0; i < lines; i++) {
             console.log();
         }
@@ -120,6 +120,11 @@ export class Logs {
         console.log(`▶︎ ${message}`);
         console.log();
     }
+    /**
+     * Formats an array of log columns or strings into a single string.
+     * @param columns Array of log columns or strings to format.
+     * @returns Formatted string.
+     */
     formatColumns(columns) {
         return columns
             .map((item) => {
@@ -134,3 +139,7 @@ export class Logs {
             .join(' ');
     }
 }
+/**
+ * Logger class for structured logging.
+ */
+export const Logs = new LogsClass();

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@tmlmobilidade/utils",
-	"version": "20250901.2024.56",
+	"version": "20250901.2033.7",
 	"author": "João de Vasconcelos & Jusi Monteiro",
 	"license": "AGPL-3.0-or-later",
 	"homepage": "https://github.com/tmlmobilidade/services#readme",