@creator.co/wapi 1.2.4 → 1.2.6

package/dist/src/Logger/Logger.d.ts

@@ -1,8 +1,10 @@
 /**
- * ${1:Description placeholder}
- *
- * @export
- * @enum {number}
+ * Enumeration of log levels.
+ * @enum {string}
+ * @property {string} DEBUG - Debug log level.
+ * @property {string} INFO - Info log level.
+ * @property {string} WARN - Warning log level.
+ * @property {string} ERROR - Error log level.
  */
 export declare enum LOG_LEVELS {
     DEBUG = "DEBUG",
@@ -11,170 +13,145 @@ export declare enum LOG_LEVELS {
     ERROR = "ERROR"
 }
 /**
- * ${1:Description placeholder}
- *
- * @export
- * @typedef {LoggerConfig}
+ * Configuration options for the logger.
+ * @typedef {Object} LoggerConfig
+ * @property {boolean | Array<string>} [sensitiveFilteringKeywords] - Specifies whether to filter sensitive keywords in log messages. Can be a boolean value or an array of strings.
+ * @property {LOG_LEVELS | string} [logLevel] - The log level to use for logging. Can be one of the predefined log levels or a custom string value.
  */
 export type LoggerConfig = {
     sensitiveFilteringKeywords?: boolean | Array<string>;
     logLevel?: LOG_LEVELS | string;
 };
 /**
- * ${1:Description placeholder}
- *
- * @export
- * @class Logger
- * @typedef {Logger}
+ * Logger class for logging messages with different log levels.
  */
 export default class Logger {
     /**
-     * ${1:Description placeholder}
-     *
-     * @private
-     * @type {?LoggerConfig}
+     * The optional configuration object for the logger.
      */
-    private _config?;
+    private config?;
     /**
-     * ${1:Description placeholder}
-     *
-     * @private
+     * Private property representing the transaction ID.
      * @type {string}
+     * @private
      */
-    private _transactionID;
+    private transactionID;
     /**
-     * ${1:Description placeholder}
-     *
-     * @private
-     * @type {(Array<string> | false)}
+     * An array of strings representing a blacklist of filters, or false if no blacklist is set.
      */
-    private _filterBlacklist;
+    private filterBlacklist;
     /**
-     * ${1:Description placeholder}
-     *
+     * The current log level for the application.
      * @private
      * @type {LOG_LEVELS}
      */
     private _LOG_LEVEL;
     /**
-     * ${1:Description placeholder}
-     *
+     * The origin of the object.
      * @private
-     * @type {*}
+     * @type {any}
      */
     private origin;
     /**
-     * Creates an instance of Logger.
-     *
-     * @constructor
-     * @param {(LoggerConfig | undefined)} _config
-     * @param {string} transactionID
+     * Constructs a Logger object with the given configuration and transaction ID.
+     * @param {config} config - The configuration object for the logger. Can be undefined.
+     * @param {string} transactionID - The ID of the transaction associated with the logger.
+     * @returns None
      */
-    constructor(_config: LoggerConfig | undefined, transactionID: string);
+    constructor(config: LoggerConfig | undefined, transactionID: string);
     /**
-     * ${1:Description placeholder}
-     *
-     * @public
-     * @returns {boolean}
+     * Returns a boolean value indicating whether the notGlobalLogger function is executed successfully.
+     * @returns {boolean} - true if the function is executed successfully, false otherwise.
      */
     notGlobalLogger(): boolean;
     /**
-     * ${1:Description placeholder}
-     *
-     * @param {...{}\} args
+     * Logs the given arguments with the debug log level.
+     * @param {...any} args - The arguments to be logged.
+     * @returns None
      */
     debug(...args: any[]): void;
     /**
-     * ${1:Description placeholder}
-     *
-     * @param {...{}\} args
+     * Logs the given arguments with the INFO log level.
+     * @param {...any} args - The arguments to be logged.
+     * @returns None
      */
     log(...args: any[]): void;
     /**
-     * ${1:Description placeholder}
-     *
-     * @param {...{}\} args
+     * Logs an informational message.
+     * @param {...any} args - The message(s) to log.
+     * @returns None
      */
     info(...args: any[]): void;
     /**
-     * ${1:Description placeholder}
-     *
-     * @param {...{}\} args
+     * Logs a warning message with the provided arguments.
+     * @param {...any} args - The arguments to be logged as a warning message.
+     * @returns None
      */
     warning(...args: any[]): void;
     /**
-     * ${1:Description placeholder}
-     *
-     * @param {...{}\} args
+     * Logs a warning message to the console.
+     * @param {...any} args - The arguments to be logged.
+     * @returns None
      */
     warn(...args: any[]): void;
     /**
-     * ${1:Description placeholder}
-     *
-     * @param {...{}\} args
+     * Logs an error message with the given arguments.
+     * @param {...any} args - The arguments to log as an error message.
+     * @returns None
      */
     error(...args: any[]): void;
     /**
-     * ${1:Description placeholder}
-     *
-     * @param {*} exception
-     * @param {...{}\} args
+     * Logs an exception with optional additional arguments.
+     * @param {any} exception - The exception to log.
+     * @param {...any} args - Additional arguments to include in the log.
+     * @returns None
      */
     exception(exception: any, ...args: any[]): void;
     /**
-     * ${1:Description placeholder}
-     *
+     * Sets up the console bindings for logging purposes.
      * @private
+     * @returns None
      */
-    private _setupBindings;
+    private setupBindings;
     /**
-     * ${1:Description placeholder}
-     *
-     * @private
-     * @param {LOG_LEVELS} level
-     * @param {Array<string>} msg
-     * @param {string} caller
-     * @returns {string}
+     * Formats a log message with the specified log level, message, and caller.
+     * @param {LOG_LEVELS} level - The log level of the message.
+     * @param {Array<string>} msg - An array of strings representing the message.
+     * @param {string} caller - The name of the caller function.
+     * @returns {string} - The formatted log message.
      */
-    private _formattedLog;
+    private formattedLog;
     /**
-     * ${1:Description placeholder}
-     *
-     * @private
-     * @param {number} index
-     * @returns {string}
+     * Returns the name of the caller at the specified index in the call stack.
+     * @param {number} index - The index of the caller in the call stack.
+     * @returns {string} The name of the caller, including the file name and line number.
      */
-    private _callerName;
+    private callerName;
     /**
-     * ${1:Description placeholder}
-     *
-     * @private
-     * @param {LOG_LEVELS} level
-     * @param {*} args
+     * Processes a log message based on the specified log level and arguments.
+     * @param {LOG_LEVELS} level - The log level of the message.
+     * @param {any[]} args - The arguments to be logged.
+     * @returns None
      */
-    private _processLog;
+    private processLog;
     /**
-     * ${1:Description placeholder}
-     *
-     * @private
-     * @param {Error} exception
-     * @param {...{}\} args
+     * Logs an exception along with additional arguments and the stack trace.
+     * @param {Error} exception - The exception object to log.
+     * @param {...any} args - Additional arguments to include in the log.
+     * @returns None
      */
-    private _exception;
+    private iexception;
     /**
-     * ${1:Description placeholder}
-     *
-     * @private
-     * @param {LOG_LEVELS} level
-     * @param {string} fMsg
+     * Pushes a log message to the console with the specified log level.
+     * @param {LOG_LEVELS} level - The log level of the message.
+     * @param {string} fMsg - The formatted log message.
+     * @returns None
      */
-    private _pushLog;
+    private pushLog;
     /**
-     * ${1:Description placeholder}
-     *
-     * @private
-     * @param {*} value
-     * @returns {string}
+     * Suppresses sensitive information in the given value based on the filter blacklist.
+     * @param {any} value - The value to suppress sensitive information from.
+     * @returns {string} - The value with sensitive information suppressed.
      */
-    private _suppressSensitiveInfo;
+    private suppressSensitiveInfo;
 }