node-logy 0.1.7 → 0.1.9

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.
Files changed (2) hide show
  1. package/README.md +65 -17
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -12,27 +12,75 @@ A lightweight logger for node js to print to console and also save them to log f
12
12
 
13
13
 
14
14
  ```ts
15
- let logger = new NodeLogger();
15
+ import { Logger } from "node-logy";
16
16
 
17
- logger.info("Hello world", "more", 123);
18
- logger.warn("Hello world");
19
- logger.error(new Error("Yo"), "some other");
17
+ const logger = new Logger({ saveToLogFiles: true, basePath: "./logs" });
18
+
19
+ // Multiple arguments of any type
20
+ logger.info({ hello: "world" }, 123, "some more");
21
+ logger.warn("Heads up!");
22
+ logger.error(new Error("Something went wrong"));
23
+
24
+ // Ensure all logs are written before exit
25
+ await logger.flush();
26
+ await logger.shutdown();
27
+ ```
28
+
29
+
30
+ console output:
31
+
32
+ ```bash
33
+ [2026-02-07T17:43:06.654Z] [INFO]: { hello: world } 123 some more
34
+ [2026-02-07T17:43:06.656Z] [ERROR]: Error { name: Error, message: Yo, stack: Error: Yo
35
+ at main (C:\dev\node-logger\tests\example.js:7:16)
36
+ at Object.<anonymous> (C:\dev\node-logger\tests\example.js:14:1)
37
+ at Module._compile (node:internal/modules/cjs/loader:1730:14)
38
+ at Object..js (node:internal/modules/cjs/loader:1895:10)
39
+ at Module.load (node:internal/modules/cjs/loader:1465:32)
40
+ at Function._load (node:internal/modules/cjs/loader:1282:12)
41
+ at TracingChannel.traceSync (node:diagnostics_channel:322:14)
42
+ at wrapModuleLoad (node:internal/modules/cjs/loader:235:24)
43
+ at Function.executeUserEntryPoint [as runMain] (node:internal/modules/run_main:170:5)
44
+ at node:internal/main/run_main_module:36:49 }
45
+ [2026-02-07T17:43:06.656Z] [WARN]: warning
46
+ ```
47
+
48
+ log file:
49
+
50
+ ```txt
51
+ [2026-02-07T17:43:06.654Z] [INFO]: { hello: world } 123 some more
52
+ [2026-02-07T17:43:06.656Z] [ERROR]: Error { name: Error, message: Yo, stack: Error: Yo
53
+ at main (C:\dev\node-logger\tests\example.js:7:16)
54
+ at Object.<anonymous> (C:\dev\node-logger\tests\example.js:14:1)
55
+ at Module._compile (node:internal/modules/cjs/loader:1730:14)
56
+ at Object..js (node:internal/modules/cjs/loader:1895:10)
57
+ at Module.load (node:internal/modules/cjs/loader:1465:32)
58
+ at Function._load (node:internal/modules/cjs/loader:1282:12)
59
+ at TracingChannel.traceSync (node:diagnostics_channel:322:14)
60
+ at wrapModuleLoad (node:internal/modules/cjs/loader:235:24)
61
+ at Function.executeUserEntryPoint [as runMain] (node:internal/modules/run_main:170:5)
62
+ at node:internal/main/run_main_module:36:49 }
63
+ [2026-02-07T17:43:06.656Z] [WARN]: warning
20
64
 
21
- await logger.flush()
22
65
  ```
23
66
 
67
+ # Performance
68
+
24
69
 
25
70
  ```bash
26
- [2026-02-07T15:33:41.587Z] [INFO]: Performance test log entry number 0
27
- [2026-02-07T15:33:41.588Z] [INFO]: Performance test log entry number 1
28
- [2026-02-07T15:33:41.588Z] [INFO]: Performance test log entry number 2
29
- [2026-02-07T15:33:41.588Z] [INFO]: Performance test log entry number 3
30
- [2026-02-07T15:33:41.588Z] [INFO]: Performance test log entry number 4
31
- [2026-02-07T15:33:41.588Z] [INFO]: Performance test log entry number 5
32
- [2026-02-07T15:33:41.588Z] [INFO]: Performance test log entry number 6
33
- [2026-02-07T15:33:41.588Z] [INFO]: Performance test log entry number 7
34
- [2026-02-07T15:33:41.588Z] [INFO]: Performance test log entry number 8
35
- [2026-02-07T15:33:41.588Z] [INFO]: Performance test log entry number 9
36
- [2026-02-07T15:33:41.588Z] [INFO]: Performance test log entry number 10
37
- [2026-02-07T15:33:41.588Z] [INFO]: Performance test log entry number 11
71
+ === Performance Test: 10,000 Log Lines ===
72
+
73
+ Total time (fire-and-forget): 32.82ms
74
+ Flush time: 8.496ms
75
+
76
+ === Results ===
77
+ Fire-and-forget loop time: 31.91ms
78
+ Flush time: 8.49ms
79
+ Total end-to-end time: 40.90ms
80
+ Average time per log: 0.004ms
81
+ Throughput: 244496 logs/second
82
+ Memory used: 0.39 MB
83
+ Log file size: 721.57 KB
84
+
85
+ === Test Complete ===
38
86
  ```
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "node-logy",
3
- "version": "0.1.7",
3
+ "version": "0.1.9",
4
4
  "description": "A lightweight Node.js logging utility that outputs logs to the console and writes them to rotating log files. Supports different log levels, timestamps, and customizable formatting for production-ready applications.",
5
5
  "main": "dist/index.js",
6
6
  "types": "dist/index.d.ts",