naloveyuki/BitLogger
1
0
Fork 0
mirror of https://github.com/Nanaloveyuki/BitLogger.git synced 2026-07-24 00:42:18 +00:00
Code Issues Packages Projects Releases Wiki Activity

📝 refine config stringify docs

Browse Source
This commit is contained in:
Nanaloveyuki
2026-06-14 01:42:16 +08:00
parent b3fb59e6b5
commit 8e409bbdf9
3 changed files with 21 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/api/stringify-logger-config.md
+7
View File
@@ -37,6 +37,7 @@ Detailed rules explaining key parameters and behaviors
- `pretty=false` produces compact JSON.
- `pretty=true` produces indented human-readable JSON.
- This helper builds on top of `logger_config_to_json(...)`.
- Internally it serializes the `JsonValue` result with `@json_parser.stringify(...)` or `@json_parser.stringify_pretty(value, 2)`, so the text form stays aligned with the structured logger-config export helper.
- Output is stable and suited for roundtrip config workflows.
### How to Use
@@ -68,3 +69,9 @@ e.g.:
- If config contains optional `queue=None`, the output omits that section rather than failing.
### Notes
1. Use this helper when the next consumer expects JSON text instead of `JsonValue`.
2. Use `logger_config_to_json(...)` when you still need to embed the config inside a larger JSON object before final stringification.