docs: sync type-equivalent JSDoc

This commit is contained in:
Tianyi Cui
2026-07-19 12:40:56 +08:00
parent 86a8046c44
commit 85ae684887
2 changed files with 4 additions and 1 deletions

View File

@@ -54,7 +54,8 @@ interface CompactionResult {
Automatic callers state why policy is running; implementations may treat confirmed overflow more aggressively than ordinary pressure.
```ts type-equiv
export type CompactionTrigger = 'pressure' | 'context-overflow'
/** Why automatic policy is asking a backend to consider compaction. */
type CompactionTrigger = 'pressure' | 'context-overflow'
```
`CompactService` exposes `compactIfNeeded(agent, trigger, signal)` for automatic `pressure` or `context-overflow` policy, returning `null` when no safe work exists, and `compactRegion(...)` for an explicit inclusive surface range. Implementations must forward the supplied signal to summarization. The seam owns no pricing API: the singleton [`ctx.tokenMeter`](token-meter.md) directly owns estimation and replay, while `dsh-compact-basic` owns retention, event sequencing, routed summarization calls, and their configuration.

View File

@@ -446,12 +446,14 @@ type ContinuationDecision =
`agent/request-error` receives the original `RequestError`, whose optional provider-neutral `code` supports stable routing without message parsing:
```ts type-equiv
/** Model-request failure with an optional machine-routable provider code. */
type RequestError = Error & { code?: string }
```
It returns a `RequestErrorDecision`; `retry` opens a new numbered step after the recovery listener's durable mutation, while `fail` preserves that error:
```ts type-equiv
/** Failed-request recovery decision; `retry` opens another numbered step while listeners delegate by calling `next()`. */
type RequestErrorDecision = { action: 'fail' } | { action: 'retry' }
```