@rabbit-company/logger 2.1.0 → 2.1.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/module/logger.d.ts +100 -0
- package/package.json +4 -2
- package/src/logger.d.ts +100 -0
|
@@ -0,0 +1,100 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Represents a logger utility for logging messages with different log levels.
|
|
3
|
+
*/
|
|
4
|
+
export default class Logger {
|
|
5
|
+
static "__#1@#NDJson": string;
|
|
6
|
+
/**
|
|
7
|
+
* Indicates whether NDJson is enabled.
|
|
8
|
+
* @type {boolean}
|
|
9
|
+
*/
|
|
10
|
+
static NDJson: boolean;
|
|
11
|
+
/**
|
|
12
|
+
* The log level of the logger.
|
|
13
|
+
* @type {number}
|
|
14
|
+
*/
|
|
15
|
+
static level: number;
|
|
16
|
+
/**
|
|
17
|
+
* Indicates whether colors are enabled for log messages.
|
|
18
|
+
* @type {boolean}
|
|
19
|
+
*/
|
|
20
|
+
static colors: boolean;
|
|
21
|
+
/**
|
|
22
|
+
* Defines log levels and their associated numeric values.
|
|
23
|
+
* @type {Object}
|
|
24
|
+
*/
|
|
25
|
+
static levels: any;
|
|
26
|
+
static "__#1@#levels": {
|
|
27
|
+
0: string;
|
|
28
|
+
1: string;
|
|
29
|
+
2: string;
|
|
30
|
+
3: string;
|
|
31
|
+
4: string;
|
|
32
|
+
5: string;
|
|
33
|
+
6: string;
|
|
34
|
+
};
|
|
35
|
+
/**
|
|
36
|
+
* Parses the log message to ensure it is a string.
|
|
37
|
+
* @param {*} message - The log message.
|
|
38
|
+
* @returns {string | null} - The parsed log message or null if the message is undefined.
|
|
39
|
+
*/
|
|
40
|
+
static parseMessage(message: any): string | null;
|
|
41
|
+
/**
|
|
42
|
+
* Formats the log message with timestamp and log level.
|
|
43
|
+
* @param {string} message - The log message.
|
|
44
|
+
* @param {number} logLevel - The log level.
|
|
45
|
+
* @returns {string} - The formatted log message.
|
|
46
|
+
*/
|
|
47
|
+
static formatMessage(message: string, logLevel: number): string;
|
|
48
|
+
/**
|
|
49
|
+
* Processes and logs a message with the specified log level.
|
|
50
|
+
* @param {*} message - The log message.
|
|
51
|
+
* @param {number} level - The log level.
|
|
52
|
+
*/
|
|
53
|
+
static "__#1@#processMessage"(message: any, level: number): void;
|
|
54
|
+
/**
|
|
55
|
+
* Logs an error message.
|
|
56
|
+
* @param {*} message - The error message.
|
|
57
|
+
*/
|
|
58
|
+
static error(message: any): void;
|
|
59
|
+
/**
|
|
60
|
+
* Logs a warning message.
|
|
61
|
+
* @param {*} message - The warning message.
|
|
62
|
+
*/
|
|
63
|
+
static warn(message: any): void;
|
|
64
|
+
/**
|
|
65
|
+
* Logs an informational message.
|
|
66
|
+
* @param {*} message - The informational message.
|
|
67
|
+
*/
|
|
68
|
+
static info(message: any): void;
|
|
69
|
+
/**
|
|
70
|
+
* Logs an HTTP-related message.
|
|
71
|
+
* @param {*} message - The HTTP-related message.
|
|
72
|
+
*/
|
|
73
|
+
static http(message: any): void;
|
|
74
|
+
/**
|
|
75
|
+
* Logs a verbose message.
|
|
76
|
+
* @param {*} message - The verbose message.
|
|
77
|
+
*/
|
|
78
|
+
static verbose(message: any): void;
|
|
79
|
+
/**
|
|
80
|
+
* Logs a debug message.
|
|
81
|
+
* @param {*} message - The debug message.
|
|
82
|
+
*/
|
|
83
|
+
static debug(message: any): void;
|
|
84
|
+
/**
|
|
85
|
+
* Logs a silly message.
|
|
86
|
+
* @param {*} message - The silly message.
|
|
87
|
+
*/
|
|
88
|
+
static silly(message: any): void;
|
|
89
|
+
/**
|
|
90
|
+
* Appends a message to NDJson format.
|
|
91
|
+
* @param {string} message - The message to append.
|
|
92
|
+
* @param {number} logLevel - The log level associated with the message.
|
|
93
|
+
*/
|
|
94
|
+
static putNDJson(message: string, logLevel: number): void;
|
|
95
|
+
/**
|
|
96
|
+
* Gets the NDJson log.
|
|
97
|
+
* @returns {string} - The NDJson log.
|
|
98
|
+
*/
|
|
99
|
+
static getNDJson(): string;
|
|
100
|
+
}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@rabbit-company/logger",
|
|
3
|
-
"version": "2.1.
|
|
3
|
+
"version": "2.1.1",
|
|
4
4
|
"description": "Simple logger",
|
|
5
5
|
"main": "./src/logger.js",
|
|
6
6
|
"browser": "./module/logger.js",
|
|
@@ -15,7 +15,9 @@
|
|
|
15
15
|
},
|
|
16
16
|
"files": [
|
|
17
17
|
"module/logger.js",
|
|
18
|
-
"
|
|
18
|
+
"module/logger.d.ts",
|
|
19
|
+
"src/logger.js",
|
|
20
|
+
"src/logger.d.ts"
|
|
19
21
|
],
|
|
20
22
|
"repository": {
|
|
21
23
|
"type": "git",
|
package/src/logger.d.ts
ADDED
|
@@ -0,0 +1,100 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Represents a logger utility for logging messages with different log levels.
|
|
3
|
+
*/
|
|
4
|
+
export default class Logger {
|
|
5
|
+
static "__#1@#NDJson": string;
|
|
6
|
+
/**
|
|
7
|
+
* Indicates whether NDJson is enabled.
|
|
8
|
+
* @type {boolean}
|
|
9
|
+
*/
|
|
10
|
+
static NDJson: boolean;
|
|
11
|
+
/**
|
|
12
|
+
* The log level of the logger.
|
|
13
|
+
* @type {number}
|
|
14
|
+
*/
|
|
15
|
+
static level: number;
|
|
16
|
+
/**
|
|
17
|
+
* Indicates whether colors are enabled for log messages.
|
|
18
|
+
* @type {boolean}
|
|
19
|
+
*/
|
|
20
|
+
static colors: boolean;
|
|
21
|
+
/**
|
|
22
|
+
* Defines log levels and their associated numeric values.
|
|
23
|
+
* @type {Object}
|
|
24
|
+
*/
|
|
25
|
+
static levels: any;
|
|
26
|
+
static "__#1@#levels": {
|
|
27
|
+
0: string;
|
|
28
|
+
1: string;
|
|
29
|
+
2: string;
|
|
30
|
+
3: string;
|
|
31
|
+
4: string;
|
|
32
|
+
5: string;
|
|
33
|
+
6: string;
|
|
34
|
+
};
|
|
35
|
+
/**
|
|
36
|
+
* Parses the log message to ensure it is a string.
|
|
37
|
+
* @param {*} message - The log message.
|
|
38
|
+
* @returns {string | null} - The parsed log message or null if the message is undefined.
|
|
39
|
+
*/
|
|
40
|
+
static parseMessage(message: any): string | null;
|
|
41
|
+
/**
|
|
42
|
+
* Formats the log message with timestamp and log level.
|
|
43
|
+
* @param {string} message - The log message.
|
|
44
|
+
* @param {number} logLevel - The log level.
|
|
45
|
+
* @returns {string} - The formatted log message.
|
|
46
|
+
*/
|
|
47
|
+
static formatMessage(message: string, logLevel: number): string;
|
|
48
|
+
/**
|
|
49
|
+
* Processes and logs a message with the specified log level.
|
|
50
|
+
* @param {*} message - The log message.
|
|
51
|
+
* @param {number} level - The log level.
|
|
52
|
+
*/
|
|
53
|
+
static "__#1@#processMessage"(message: any, level: number): void;
|
|
54
|
+
/**
|
|
55
|
+
* Logs an error message.
|
|
56
|
+
* @param {*} message - The error message.
|
|
57
|
+
*/
|
|
58
|
+
static error(message: any): void;
|
|
59
|
+
/**
|
|
60
|
+
* Logs a warning message.
|
|
61
|
+
* @param {*} message - The warning message.
|
|
62
|
+
*/
|
|
63
|
+
static warn(message: any): void;
|
|
64
|
+
/**
|
|
65
|
+
* Logs an informational message.
|
|
66
|
+
* @param {*} message - The informational message.
|
|
67
|
+
*/
|
|
68
|
+
static info(message: any): void;
|
|
69
|
+
/**
|
|
70
|
+
* Logs an HTTP-related message.
|
|
71
|
+
* @param {*} message - The HTTP-related message.
|
|
72
|
+
*/
|
|
73
|
+
static http(message: any): void;
|
|
74
|
+
/**
|
|
75
|
+
* Logs a verbose message.
|
|
76
|
+
* @param {*} message - The verbose message.
|
|
77
|
+
*/
|
|
78
|
+
static verbose(message: any): void;
|
|
79
|
+
/**
|
|
80
|
+
* Logs a debug message.
|
|
81
|
+
* @param {*} message - The debug message.
|
|
82
|
+
*/
|
|
83
|
+
static debug(message: any): void;
|
|
84
|
+
/**
|
|
85
|
+
* Logs a silly message.
|
|
86
|
+
* @param {*} message - The silly message.
|
|
87
|
+
*/
|
|
88
|
+
static silly(message: any): void;
|
|
89
|
+
/**
|
|
90
|
+
* Appends a message to NDJson format.
|
|
91
|
+
* @param {string} message - The message to append.
|
|
92
|
+
* @param {number} logLevel - The log level associated with the message.
|
|
93
|
+
*/
|
|
94
|
+
static putNDJson(message: string, logLevel: number): void;
|
|
95
|
+
/**
|
|
96
|
+
* Gets the NDJson log.
|
|
97
|
+
* @returns {string} - The NDJson log.
|
|
98
|
+
*/
|
|
99
|
+
static getNDJson(): string;
|
|
100
|
+
}
|