@thi.ng/rstream-log 5.0.0 → 5.0.1

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 # Change Log
 
-- **Last updated**: 2024-02-16T20:01:44Z
+- **Last updated**: 2024-02-16T20:48:02Z
 - **Generator**: [thi.ng/monopub](https://thi.ng/monopub)
 
 All notable changes to this project will be documented in this file.
@@ -9,6 +9,12 @@ See [Conventional Commits](https://conventionalcommits.org/) for commit guidelin
 **Note:** Unlisted _patch_ versions only involve non-code or otherwise excluded changes
 and/or version bumps of transitive dependencies.
 
+### [5.0.1](https://github.com/thi-ng/umbrella/tree/@thi.ng/rstream-log@5.0.1) (2024-02-16)
+
+#### 🩹 Bug fixes
+
+- fix Logger.logEntry() & .childLogger() impls ([3484617](https://github.com/thi-ng/umbrella/commit/3484617))
+
 # [5.0.0](https://github.com/thi-ng/umbrella/tree/@thi.ng/rstream-log@5.0.0) (2024-02-16)
 
 #### 🛑 Breaking changes

package/README.md

@@ -44,10 +44,10 @@ infrastructure, with logged values transformable via
 [@thi.ng/transducers](https://github.com/thi-ng/umbrella/tree/develop/packages/transducers).
 Several built-in transformers are provided.
 
-The `Logger` class provided by this package implements the
-[@thi.ng/api](https://github.com/thi-ng/umbrella/tree/develop/packages/api)
+The `Logger` class in this package implements the
+[@thi.ng/logger](https://github.com/thi-ng/umbrella/tree/develop/packages/logger)
 `ILogger` interface and uses `LogLevel` enums to configure levels /
-filtering.
+filtering. See that package for more details.
 
 ## Status
 
@@ -83,7 +83,7 @@ For Node.js REPL:
 const rstreamLog = await import("@thi.ng/rstream-log");
 ```
 
-Package sizes (brotli'd, pre-treeshake): ESM: 707 bytes
+Package sizes (brotli'd, pre-treeshake): ESM: 715 bytes
 
 ## Dependencies
 
@@ -98,42 +98,38 @@ Package sizes (brotli'd, pre-treeshake): ESM: 707 bytes
 
 [Generated API docs](https://docs.thi.ng/umbrella/rstream-log/)
 
-```ts
-import { LogLevel } from "@thi.ng/api";
-import * as log from "@thi.ng/rstream-log";
+```ts tangle:export/readme.ts
+import { LogLevel } from "@thi.ng/logger";
+import { Logger, formatString, writeConsole } from "@thi.ng/rstream-log";
 
-const logger = new log.Logger("main");
+const logger = new Logger("main");
 // or with min level
-const logger = new log.Logger("main", LogLevel.DEBUG);
+const logger = new Logger("main", LogLevel.DEBUG);
+// or min level given as string
+const logger = new Logger("main", "DEBUG");
 
 // add console output w/ string formatter (a transducer)
-logger.subscribe(log.writeConsole(), log.formatString());
+// each logger instance has a rstream Stream instance
+// allowing for downstream processing
+logger.stream.transform(formatString()).subscribe(writeConsole());
 
 logger.debug("hello world");
-// [DEBUG] [main] 2018-01-20T09:04:05.198Z hello world
+// [DEBUG] main: 2024-02-16T20:38:11.143Z hello world
 
 logger.warn("eek");
-// [WARN] [main] 2018-01-20T09:04:16.913Z eek
+// [WARN] main: 2024-02-16T20:38:11.144Z eek
 
-// each logger instance is a rstream StreamMerge instance
-// allowing to form logger hierarchies
-
-const mod1 = new log.Logger("module-1", LogLevel.INFO);
-// pipe mod1 into main logger
-logger.add(mod1);
+// loggers can form hierarchies by creating/attaching child loggers
+const child = logger.childLogger("child", LogLevel.INFO);
 
 import { postWorker } from "@thi.ng/rstream";
 // additionally send messages from this logger to worker
-mod1.subscribe(postWorker("log-worker.js"));
-
-mod1.info("hi from sub-module");
+child.stream.subscribe(postWorker("log-worker.js"));
 
-// only shown in console:
-// [INFO] [module-1] 2018-01-20T09:05:21.198Z hi from sub-module
+child.info("hi from submodule");
+// [INFO] child: 2024-02-16T20:38:11.145Z hi from submodule
 ```
 
-TODO
-
 ## Authors
 
 - [Karsten Schmidt](https://thi.ng)

package/logger.d.ts

@@ -1,13 +1,13 @@
 import { ALogger } from "@thi.ng/logger/alogger";
-import { LogLevel, type ILogger, type LogEntry } from "@thi.ng/logger/api";
+import { LogLevel, type ILogger, type LogEntry, type LogLevelName } from "@thi.ng/logger/api";
 import { Stream, type ISubscriber } from "@thi.ng/rstream";
 export declare class Logger extends ALogger implements ISubscriber<LogEntry> {
     stream: Stream<LogEntry>;
-    constructor(id: string, level?: LogLevel, parent?: ILogger);
+    constructor(id: string, level?: LogLevel | LogLevelName, parent?: ILogger);
     next(x: LogEntry): void;
     done(): void;
     error(e: Error): boolean;
     logEntry(e: LogEntry): void;
-    childLogger(id: string, level?: LogLevel): ILogger;
+    childLogger(id: string, level?: LogLevel): Logger;
 }
 //# sourceMappingURL=logger.d.ts.map

package/logger.js

@@ -1,6 +1,8 @@
 import { ALogger } from "@thi.ng/logger/alogger";
-import { LogLevel } from "@thi.ng/logger/api";
-import { Stream, CloseMode } from "@thi.ng/rstream";
+import {
+  LogLevel
+} from "@thi.ng/logger/api";
+import { CloseMode, Stream } from "@thi.ng/rstream";
 class Logger extends ALogger {
   stream;
   constructor(id, level, parent) {
@@ -11,7 +13,7 @@ class Logger extends ALogger {
     });
   }
   next(x) {
-    x[0] >= this.level && this.stream.next(x);
+    this.logEntry(x);
   }
   done() {
     this.stream.done();
@@ -20,11 +22,13 @@ class Logger extends ALogger {
     return this.stream.error(e);
   }
   logEntry(e) {
-    if (this.level <= e[0])
+    if (e[0] >= this.level) {
       this.stream.next(e);
+      this.parent && this.parent.logEntry(e);
+    }
   }
   childLogger(id, level) {
-    return new Logger(id, level ?? this.level, this.parent);
+    return new Logger(id, level ?? this.level, this);
   }
 }
 export {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thi.ng/rstream-log",
-  "version": "5.0.0",
+  "version": "5.0.1",
   "description": "Structured, multilevel & hierarchical loggers based on @thi.ng/rstream",
   "type": "module",
   "module": "./index.js",
@@ -97,5 +97,5 @@
     ],
     "year": 2017
   },
-  "gitHead": "25ee18f7db6d03f0b76787267ab071d16df94888\n"
+  "gitHead": "31173a8ccccdc296c104602d8d9db8b6553fd305\n"
 }