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

📝 align sync API docs with owner packages

Browse Source
This commit is contained in:
Nanaloveyuki
2026-07-07 20:05:10 +08:00
parent 2bee0b1da8
commit cf80e583ac
46 changed files with 183 additions and 98 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/api/runtime-sink-file-rotation-config.md
+3
View File
@@ -15,6 +15,8 @@ key-word:
Read the current rotation configuration used by a file-backed `RuntimeSink`. This helper exposes active direct runtime rotation parameters when rotation is enabled.
The returned `FileRotation` value is owned by `src/file_model`; this method belongs to the runtime facade layer and reads rotation policy through `src/runtime` over file-backed variants that ultimately use `src/file_runtime.FileSink`.
### Interface
```moonbit
@@ -35,6 +37,7 @@ Detailed rules explaining key parameters and behaviors
- Plain `File` runtime variants return the current rotation config from the wrapped `FileSink`.
- `QueuedFile` runtime variants forward the config from the wrapped inner `FileSink`.
- The returned rotation object itself is the shared `@file_model.FileRotation` model, not a runtime-owned concrete type.
- Non-file runtime variants return `None`.
- This helper is useful when callers need the active direct runtime policy rather than only a boolean flag.