From e13ea2209a440446eb66ba30d0e74b6fd9a8efa2 Mon Sep 17 00:00:00 2001 From: Nanaloveyuki Date: Sun, 14 Jun 2026 01:58:06 +0800 Subject: [PATCH] :memo: clarify async config type docs --- docs/api/async-logger-build-config-type.md | 1 + docs/api/async-logger-config-type.md | 1 + 2 files changed, 2 insertions(+) diff --git a/docs/api/async-logger-build-config-type.md b/docs/api/async-logger-build-config-type.md index d69c2ec..be27a49 100644 --- a/docs/api/async-logger-build-config-type.md +++ b/docs/api/async-logger-build-config-type.md @@ -31,6 +31,7 @@ Detailed rules explaining key parameters and behaviors - This is a type alias, not a built logger instance. - The current fields are `logger : LoggerConfig` and `async_config : AsyncLoggerConfig`. +- The public `src-async` surface forwards this alias directly from `@utils.AsyncLoggerBuildConfig`, so constructor, parser, export, and stringify helpers all operate on one shared underlying build-config model. - `AsyncLoggerBuildConfig::new(...)` constructs this type as the main handoff object for async build flows. - `build_async_logger(...)`, `build_async_text_logger(...)`, `parse_async_logger_build_config_text(...)`, `async_logger_build_config_to_json(...)`, and `stringify_async_logger_build_config(...)` all consume or produce this same public shape. - `build_async_logger(...)` consumes the full sync build path by calling `build_logger(config.logger)` first, so `LoggerConfig.sink`, `LoggerConfig.queue`, and the resulting runtime sink behavior all participate before the async layer is added. diff --git a/docs/api/async-logger-config-type.md b/docs/api/async-logger-config-type.md index c5a1979..8ce7f77 100644 --- a/docs/api/async-logger-config-type.md +++ b/docs/api/async-logger-config-type.md @@ -31,6 +31,7 @@ Detailed rules explaining key parameters and behaviors - This is a type alias, not a runtime logger handle. - The current fields are `max_pending : Int`, `overflow : AsyncOverflowPolicy`, `max_batch : Int`, `linger_ms : Int`, and `flush : AsyncFlushPolicy`. +- The public `src-async` surface forwards this alias directly from `@utils.AsyncLoggerConfig`, so constructor, parser, export, and stringify helpers all operate on one shared underlying config model. - `AsyncLoggerConfig::new(...)` normalizes `max_batch` and `linger_ms`, but it preserves the provided `max_pending` value. - Runtime queue creation later interprets negative `max_pending` as `0` when choosing the internal queue kind. - `parse_async_logger_config_text(...)`, `async_logger_config_to_json(...)`, and `stringify_async_logger_config(...)` all operate on this same public config shape.