📝 Update More API Document

This commit is contained in:
Nanaloveyuki
2026-05-20 11:37:49 +08:00
parent 55af0b664f
commit 25a6a973d2
41 changed files with 2484 additions and 15 deletions
@@ -0,0 +1,66 @@
---
name: parse-async-logger-config-text
group: api
category: async
update-time: 20260520
description: Parse JSON text into an AsyncLoggerConfig.
key-word:
- async
- config
- parse
- public
---
## Parse-async-logger-config-text
Parse raw JSON text into `AsyncLoggerConfig`. This helper is the text-entry counterpart to `AsyncLoggerConfig::new(...)` when async queue and flush policy should be configured from serialized data.
### Interface
```moonbit
pub fn parse_async_logger_config_text(input : String) -> AsyncLoggerConfig raise {
```
#### input
- `input : String` - Raw JSON text describing async queue, batching, linger, and flush settings.
#### output
- `AsyncLoggerConfig` - Parsed async runtime config value.
### Explanation
Detailed rules explaining key parameters and behaviors
- This helper parses only the async config portion, not the embedded sync `LoggerConfig`.
- Parsed values follow the same normalization and enum validation rules as other async config helpers.
- Use this API when async policy comes from config text but sink choice is still assembled elsewhere.
### How to Use
Here are some specific examples provided.
#### When Need Async Queue Policy From JSON
When async queue behavior is loaded separately from sync sink config:
```moonbit
let config = parse_async_logger_config_text(
"{\"max_pending\":8,\"overflow\":\"DropOldest\",\"max_batch\":3,\"linger_ms\":25,\"flush\":\"Batch\"}",
)
```
In this example, async queue and flush policy are parsed from text into a typed config object.
### Error Case
e.g.:
- If the JSON text is malformed, parsing raises an error.
- If enum names such as `overflow` or `flush` are unsupported, parsing raises an error.
### Notes
1. Use this helper when only async policy is text-driven.
2. Use `parse_async_logger_build_config_text(...)` when both sync logger config and async config come from the same JSON payload.