From 64dfc369317dcecb48d8308ef24e12fd7612e7b9 Mon Sep 17 00:00:00 2001 From: Nanaloveyuki Date: Sun, 14 Jun 2026 10:11:41 +0800 Subject: [PATCH] :memo: clarify async runtime json snapshot semantics --- docs/api/async-runtime-state-to-json.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/api/async-runtime-state-to-json.md b/docs/api/async-runtime-state-to-json.md index dd511bf..19185c3 100644 --- a/docs/api/async-runtime-state-to-json.md +++ b/docs/api/async-runtime-state-to-json.md @@ -38,6 +38,8 @@ Detailed rules explaining key parameters and behaviors - The compact serialized shape is `{"mode":"native_worker|compatibility","background_worker":true|false}`. - This helper focuses on runtime capabilities rather than queue counters or logger lifecycle flags. - The exported JSON is suitable for diagnostics endpoints and startup environment checks. +- This helper serializes the provided `AsyncRuntimeState` exactly as given; it does not call `async_runtime_state()` or recheck backend capability by itself. +- That means manually constructed runtime snapshots are exported unchanged, with `mode` relabeled through `async_runtime_mode_label(...)` and `background_worker` kept exactly as supplied. ### How to Use @@ -68,6 +70,8 @@ e.g.: - If the runtime is in compatibility mode, the helper still serializes normally using the matching mode label. +- If callers need the current backend-derived runtime rather than an older or synthetic snapshot, they must capture a fresh `async_runtime_state()` first. + ### Notes 1. The output field names are fixed as `mode` and `background_worker`.