@ix-xs/node-comfort 1.0.2 → 1.0.3

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/core/Logger.js CHANGED
@@ -202,7 +202,6 @@ module.exports = {
202
202
  * Supports strings, objects (pretty JSON), and chaining.
203
203
  *
204
204
  * @param {any} content - Content to log (string, object, or primitive).
205
- * @returns {this} Chainable instance.
206
205
  * @example
207
206
  * nodeComfort.log("<%greenBright ✓ Done%>");
208
207
  * nodeComfort.log({ users: 42, active: true });
@@ -268,7 +267,6 @@ module.exports = {
268
267
  * Starts a new log group with ▼ indicator and increased indentation.
269
268
  *
270
269
  * @param {string} label - Group label (supports colors).
271
- * @returns {this} Chainable instance.
272
270
  * @example
273
271
  * nodeComfort.group("<%yellow Processing%>").log("Step 1").groupEnd();
274
272
  */
@@ -282,7 +280,6 @@ module.exports = {
282
280
  /**
283
281
  * Ends current group and reduces indentation.
284
282
  *
285
- * @returns {this} Chainable instance.
286
283
  * @example
287
284
  * nodeComfort.group("Work").groupEnd();
288
285
  */
@@ -299,7 +296,6 @@ module.exports = {
299
296
  * @param {string} [options.delimiters.start="<%="] - Start delimiter.
300
297
  * @param {string} [options.delimiters.end="%>"] - End delimiter.
301
298
  * @param {boolean} [options.timestamp=true] - Show timestamps.
302
- * @returns {this} Chainable instance.
303
299
  * @example
304
300
  * nodeComfort.setLogger({
305
301
  * delimiters: { start: "{{", end: "}}" },
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@ix-xs/node-comfort",
3
- "version": "1.0.2",
3
+ "version": "1.0.3",
4
4
  "description": "",
5
5
  "main": "index.js",
6
6
  "types": "types/index.d.ts",
@@ -3,13 +3,60 @@
3
3
  * Supports strings, objects (pretty JSON), and chaining.
4
4
  *
5
5
  * @param {any} content - Content to log (string, object, or primitive).
6
- * @returns {this} Chainable instance.
7
6
  * @example
8
7
  * nodeComfort.log("<%greenBright ✓ Done%>");
9
8
  * nodeComfort.log({ users: 42, active: true });
10
9
  * nodeComfort.group("Files").log("Processing...").groupEnd();
11
10
  */
12
- export function log(content: any): this;
11
+ export function log(content: any): {
12
+ log(content: any): /*elided*/ any;
13
+ /**
14
+ * Formats content with colors, timestamp, and group indentation (no console output).
15
+ *
16
+ * @param {any} content - Content to format.
17
+ * @returns {string} Formatted string.
18
+ * @example
19
+ * const msg = nodeComfort.logify("<%redBright ERROR%> Invalid input");
20
+ * console.log(msg);
21
+ */
22
+ logify(content: any): string;
23
+ /**
24
+ * Starts a new log group with ▼ indicator and increased indentation.
25
+ *
26
+ * @param {string} label - Group label (supports colors).
27
+ * @example
28
+ * nodeComfort.group("<%yellow Processing%>").log("Step 1").groupEnd();
29
+ */
30
+ group(label: string): /*elided*/ any;
31
+ /**
32
+ * Ends current group and reduces indentation.
33
+ *
34
+ * @example
35
+ * nodeComfort.group("Work").groupEnd();
36
+ */
37
+ groupEnd(): /*elided*/ any;
38
+ /**
39
+ * Configures logger options (delimiters and timestamp).
40
+ *
41
+ * @param {object} [options] - Logger options.
42
+ * @param {object} [options.delimiters] - Template delimiters.
43
+ * @param {string} [options.delimiters.start="<%="] - Start delimiter.
44
+ * @param {string} [options.delimiters.end="%>"] - End delimiter.
45
+ * @param {boolean} [options.timestamp=true] - Show timestamps.
46
+ * @example
47
+ * nodeComfort.setLogger({
48
+ * delimiters: { start: "{{", end: "}}" },
49
+ * timestamp: false
50
+ * }).log("{{ bgGreen new delimiters }}");
51
+ */
52
+ setLogger(options?: {
53
+ delimiters?: {
54
+ start?: string;
55
+ end?: string;
56
+ };
57
+ timestamp?: boolean;
58
+ }): /*elided*/ any;
59
+ };
13
60
  /**
14
61
  * Formats content with colors, timestamp, and group indentation (no console output).
15
62
  *
@@ -24,19 +71,120 @@ export function logify(content: any): string;
24
71
  * Starts a new log group with ▼ indicator and increased indentation.
25
72
  *
26
73
  * @param {string} label - Group label (supports colors).
27
- * @returns {this} Chainable instance.
28
74
  * @example
29
75
  * nodeComfort.group("<%yellow Processing%>").log("Step 1").groupEnd();
30
76
  */
31
- export function group(label: string): this;
77
+ export function group(label: string): {
78
+ /**
79
+ * Logs content with colors, timestamp, and group indentation.
80
+ * Supports strings, objects (pretty JSON), and chaining.
81
+ *
82
+ * @param {any} content - Content to log (string, object, or primitive).
83
+ * @example
84
+ * nodeComfort.log("<%greenBright ✓ Done%>");
85
+ * nodeComfort.log({ users: 42, active: true });
86
+ * nodeComfort.group("Files").log("Processing...").groupEnd();
87
+ */
88
+ log(content: any): /*elided*/ any;
89
+ /**
90
+ * Formats content with colors, timestamp, and group indentation (no console output).
91
+ *
92
+ * @param {any} content - Content to format.
93
+ * @returns {string} Formatted string.
94
+ * @example
95
+ * const msg = nodeComfort.logify("<%redBright ERROR%> Invalid input");
96
+ * console.log(msg);
97
+ */
98
+ logify(content: any): string;
99
+ group(label: string): /*elided*/ any;
100
+ /**
101
+ * Ends current group and reduces indentation.
102
+ *
103
+ * @example
104
+ * nodeComfort.group("Work").groupEnd();
105
+ */
106
+ groupEnd(): /*elided*/ any;
107
+ /**
108
+ * Configures logger options (delimiters and timestamp).
109
+ *
110
+ * @param {object} [options] - Logger options.
111
+ * @param {object} [options.delimiters] - Template delimiters.
112
+ * @param {string} [options.delimiters.start="<%="] - Start delimiter.
113
+ * @param {string} [options.delimiters.end="%>"] - End delimiter.
114
+ * @param {boolean} [options.timestamp=true] - Show timestamps.
115
+ * @example
116
+ * nodeComfort.setLogger({
117
+ * delimiters: { start: "{{", end: "}}" },
118
+ * timestamp: false
119
+ * }).log("{{ bgGreen new delimiters }}");
120
+ */
121
+ setLogger(options?: {
122
+ delimiters?: {
123
+ start?: string;
124
+ end?: string;
125
+ };
126
+ timestamp?: boolean;
127
+ }): /*elided*/ any;
128
+ };
32
129
  /**
33
130
  * Ends current group and reduces indentation.
34
131
  *
35
- * @returns {this} Chainable instance.
36
132
  * @example
37
133
  * nodeComfort.group("Work").groupEnd();
38
134
  */
39
- export function groupEnd(): this;
135
+ export function groupEnd(): {
136
+ /**
137
+ * Logs content with colors, timestamp, and group indentation.
138
+ * Supports strings, objects (pretty JSON), and chaining.
139
+ *
140
+ * @param {any} content - Content to log (string, object, or primitive).
141
+ * @example
142
+ * nodeComfort.log("<%greenBright ✓ Done%>");
143
+ * nodeComfort.log({ users: 42, active: true });
144
+ * nodeComfort.group("Files").log("Processing...").groupEnd();
145
+ */
146
+ log(content: any): /*elided*/ any;
147
+ /**
148
+ * Formats content with colors, timestamp, and group indentation (no console output).
149
+ *
150
+ * @param {any} content - Content to format.
151
+ * @returns {string} Formatted string.
152
+ * @example
153
+ * const msg = nodeComfort.logify("<%redBright ERROR%> Invalid input");
154
+ * console.log(msg);
155
+ */
156
+ logify(content: any): string;
157
+ /**
158
+ * Starts a new log group with ▼ indicator and increased indentation.
159
+ *
160
+ * @param {string} label - Group label (supports colors).
161
+ * @example
162
+ * nodeComfort.group("<%yellow Processing%>").log("Step 1").groupEnd();
163
+ */
164
+ group(label: string): /*elided*/ any;
165
+ groupEnd(): /*elided*/ any;
166
+ /**
167
+ * Configures logger options (delimiters and timestamp).
168
+ *
169
+ * @param {object} [options] - Logger options.
170
+ * @param {object} [options.delimiters] - Template delimiters.
171
+ * @param {string} [options.delimiters.start="<%="] - Start delimiter.
172
+ * @param {string} [options.delimiters.end="%>"] - End delimiter.
173
+ * @param {boolean} [options.timestamp=true] - Show timestamps.
174
+ * @example
175
+ * nodeComfort.setLogger({
176
+ * delimiters: { start: "{{", end: "}}" },
177
+ * timestamp: false
178
+ * }).log("{{ bgGreen new delimiters }}");
179
+ */
180
+ setLogger(options?: {
181
+ delimiters?: {
182
+ start?: string;
183
+ end?: string;
184
+ };
185
+ timestamp?: boolean;
186
+ }): /*elided*/ any;
187
+ };
40
188
  /**
41
189
  * Configures logger options (delimiters and timestamp).
42
190
  *
@@ -45,7 +193,6 @@ export function groupEnd(): this;
45
193
  * @param {string} [options.delimiters.start="<%="] - Start delimiter.
46
194
  * @param {string} [options.delimiters.end="%>"] - End delimiter.
47
195
  * @param {boolean} [options.timestamp=true] - Show timestamps.
48
- * @returns {this} Chainable instance.
49
196
  * @example
50
197
  * nodeComfort.setLogger({
51
198
  * delimiters: { start: "{{", end: "}}" },
@@ -58,5 +205,49 @@ export function setLogger(options?: {
58
205
  end?: string;
59
206
  };
60
207
  timestamp?: boolean;
61
- }): this;
208
+ }): {
209
+ /**
210
+ * Logs content with colors, timestamp, and group indentation.
211
+ * Supports strings, objects (pretty JSON), and chaining.
212
+ *
213
+ * @param {any} content - Content to log (string, object, or primitive).
214
+ * @example
215
+ * nodeComfort.log("<%greenBright ✓ Done%>");
216
+ * nodeComfort.log({ users: 42, active: true });
217
+ * nodeComfort.group("Files").log("Processing...").groupEnd();
218
+ */
219
+ log(content: any): /*elided*/ any;
220
+ /**
221
+ * Formats content with colors, timestamp, and group indentation (no console output).
222
+ *
223
+ * @param {any} content - Content to format.
224
+ * @returns {string} Formatted string.
225
+ * @example
226
+ * const msg = nodeComfort.logify("<%redBright ERROR%> Invalid input");
227
+ * console.log(msg);
228
+ */
229
+ logify(content: any): string;
230
+ /**
231
+ * Starts a new log group with ▼ indicator and increased indentation.
232
+ *
233
+ * @param {string} label - Group label (supports colors).
234
+ * @example
235
+ * nodeComfort.group("<%yellow Processing%>").log("Step 1").groupEnd();
236
+ */
237
+ group(label: string): /*elided*/ any;
238
+ /**
239
+ * Ends current group and reduces indentation.
240
+ *
241
+ * @example
242
+ * nodeComfort.group("Work").groupEnd();
243
+ */
244
+ groupEnd(): /*elided*/ any;
245
+ setLogger(options?: {
246
+ delimiters?: {
247
+ start?: string;
248
+ end?: string;
249
+ };
250
+ timestamp?: boolean;
251
+ }): /*elided*/ any;
252
+ };
62
253
  //# sourceMappingURL=Logger.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"Logger.d.ts","sourceRoot":"","sources":["../../core/Logger.js"],"names":[],"mappings":"AAuME;;;;;;;;;;KAUE;AACF,6BAPU,GAAG,GACD,IAAI,CAqCf;AAED;;;;;;;;KAQE;AACF,gCANU,GAAG,GACD,MAAM,CAiBjB;AAED;;;;;;;KAOE;AACF,6BALU,MAAM,GACJ,IAAI,CASf;AAED;;;;;;KAME;AACF,4BAJY,IAAI,CAOf;AAED;;;;;;;;;;;;;;KAcE;AACF,oCAXE;IAAyB,UAAU,GACnC;QAAoC,KAAK,GAAjC,MAAM;QACsB,GAAG,GAA/B,MAAM;KACd;IAA0B,SAAS,GAA3B,OAAO;CACf,GAAU,IAAI,CAkBf"}
1
+ {"version":3,"file":"Logger.d.ts","sourceRoot":"","sources":["../../core/Logger.js"],"names":[],"mappings":"AAuME;;;;;;;;;KASE;AACF,6BANU,GAAG;iBAAH,GAAG;IAuCb;;;;;;;;SAQE;oBALQ,GAAG,GACD,MAAM;IAmBlB;;;;;;SAME;iBAHQ,MAAM;IAWhB;;;;;SAKE;;IAMF;;;;;;;;;;;;;SAaE;wBATA;QAAyB,UAAU,GACnC;YAAoC,KAAK,GAAjC,MAAM;YACsB,GAAG,GAA/B,MAAM;SACd;QAA0B,SAAS,GAA3B,OAAO;KACf;EA1DD;AAED;;;;;;;;KAQE;AACF,gCANU,GAAG,GACD,MAAM,CAiBjB;AAED;;;;;;KAME;AACF,6BAJU,MAAM;IArEhB;;;;;;;;;SASE;iBALQ,GAAG;IAuCb;;;;;;;;SAQE;oBALQ,GAAG,GACD,MAAM;iBAsBR,MAAM;IAWhB;;;;;SAKE;;IAMF;;;;;;;;;;;;;SAaE;wBATA;QAAyB,UAAU,GACnC;YAAoC,KAAK,GAAjC,MAAM;YACsB,GAAG,GAA/B,MAAM;SACd;QAA0B,SAAS,GAA3B,OAAO;KACf;EArBD;AAED;;;;;KAKE;AACF;IAtFA;;;;;;;;;SASE;iBALQ,GAAG;IAuCb;;;;;;;;SAQE;oBALQ,GAAG,GACD,MAAM;IAmBlB;;;;;;SAME;iBAHQ,MAAM;;IAsBhB;;;;;;;;;;;;;SAaE;wBATA;QAAyB,UAAU,GACnC;YAAoC,KAAK,GAAjC,MAAM;YACsB,GAAG,GAA/B,MAAM;SACd;QAA0B,SAAS,GAA3B,OAAO;KACf;EAVD;AAED;;;;;;;;;;;;;KAaE;AACF,oCAVE;IAAyB,UAAU,GACnC;QAAoC,KAAK,GAAjC,MAAM;QACsB,GAAG,GAA/B,MAAM;KACd;IAA0B,SAAS,GAA3B,OAAO;CACf;IAnGF;;;;;;;;;SASE;iBALQ,GAAG;IAuCb;;;;;;;;SAQE;oBALQ,GAAG,GACD,MAAM;IAmBlB;;;;;;SAME;iBAHQ,MAAM;IAWhB;;;;;SAKE;;wBAUA;QAAyB,UAAU,GACnC;YAAoC,KAAK,GAAjC,MAAM;YACsB,GAAG,GAA/B,MAAM;SACd;QAA0B,SAAS,GAA3B,OAAO;KACf;EAiBD"}
package/types/index.d.ts CHANGED
@@ -29,17 +29,65 @@ declare const _exports: {
29
29
  reset(): /*elided*/ any;
30
30
  all(): /*elided*/ any;
31
31
  };
32
- log(content: any): this;
32
+ log(content: any): {
33
+ log(content: any): /*elided*/ any;
34
+ logify(content: any): string;
35
+ group(label: string): /*elided*/ any;
36
+ groupEnd(): /*elided*/ any;
37
+ setLogger(options?: {
38
+ delimiters?: {
39
+ start?: string;
40
+ end?: string;
41
+ };
42
+ timestamp?: boolean;
43
+ }): /*elided*/ any;
44
+ };
33
45
  logify(content: any): string;
34
- group(label: string): this;
35
- groupEnd(): this;
46
+ group(label: string): {
47
+ log(content: any): /*elided*/ any;
48
+ logify(content: any): string;
49
+ group(label: string): /*elided*/ any;
50
+ groupEnd(): /*elided*/ any;
51
+ setLogger(options?: {
52
+ delimiters?: {
53
+ start?: string;
54
+ end?: string;
55
+ };
56
+ timestamp?: boolean;
57
+ }): /*elided*/ any;
58
+ };
59
+ groupEnd(): {
60
+ log(content: any): /*elided*/ any;
61
+ logify(content: any): string;
62
+ group(label: string): /*elided*/ any;
63
+ groupEnd(): /*elided*/ any;
64
+ setLogger(options?: {
65
+ delimiters?: {
66
+ start?: string;
67
+ end?: string;
68
+ };
69
+ timestamp?: boolean;
70
+ }): /*elided*/ any;
71
+ };
36
72
  setLogger(options?: {
37
73
  delimiters?: {
38
74
  start?: string;
39
75
  end?: string;
40
76
  };
41
77
  timestamp?: boolean;
42
- }): this;
78
+ }): {
79
+ log(content: any): /*elided*/ any;
80
+ logify(content: any): string;
81
+ group(label: string): /*elided*/ any;
82
+ groupEnd(): /*elided*/ any;
83
+ setLogger(options?: {
84
+ delimiters?: {
85
+ start?: string;
86
+ end?: string;
87
+ };
88
+ timestamp?: boolean;
89
+ }): /*elided*/ any;
90
+ };
43
91
  createPath(path?: string): string;
44
92
  getFoldersIn(path?: string, recursive?: boolean): string[] | undefined;
45
93
  getFolder(path?: string): string | undefined;