mirror of
https://github.com/Nanaloveyuki/BitLogger.git
synced 2026-07-27 10:22:18 +00:00
📝 consolidate logger API and async lifecycle guidance
This commit is contained in:
@@ -35,6 +35,7 @@ Detailed rules explaining key parameters and behaviors
|
||||
|
||||
- The output includes `max_pending` and `overflow`.
|
||||
- Overflow is serialized using the supported config labels such as `DropNewest` and `DropOldest`.
|
||||
- `max_pending` is emitted as a JSON number and `overflow` is emitted as the stable parser-facing text label, so the result stays aligned with `parse_logger_config_text(...)` roundtrips.
|
||||
- This helper is intended for config export rather than runtime queue inspection.
|
||||
- The JSON shape matches the queue section accepted by `parse_logger_config_text(...)`.
|
||||
|
||||
@@ -69,3 +70,9 @@ e.g.:
|
||||
|
||||
- If callers need direct text output instead of a JSON value, they should use `stringify_queue_config(...)` instead.
|
||||
|
||||
### Notes
|
||||
|
||||
1. Use this helper when you need a reusable JSON value rather than a final JSON string.
|
||||
|
||||
2. Use `stringify_queue_config(...)` when the next consumer expects text instead of `JsonValue`.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user