Skip to content

Commit 4650bae

Browse files
committed
docs: reattach JSDoc to fetchOnce and document the abort hook
The shared-request cache refactor inserted the cachedRequest/cachedAdapter declarations between the fetchOnce JSDoc and the function itself, orphaning the doc block; reattach an adjacent JSDoc to both fetchOnce declarations and add one to the bounded-body onAbort hook so the declarations stay documented.
1 parent c3b0ec8 commit 4650bae

3 files changed

Lines changed: 12 additions & 0 deletions

File tree

‎src/images/loop.ts‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -451,6 +451,10 @@ export async function runWithImageBridge(deps: ImageBridgeDeps): Promise<Respons
451451
*/
452452
let cachedRequest: AdapterRequest | undefined;
453453
let cachedAdapter: ProviderAdapter | undefined;
454+
/**
455+
* Build and fetch one image-bridge iteration on the given adapter, under the iteration
456+
* header deadline. The caller owns same-target 429 replays and key rotation around it.
457+
*/
454458
const fetchOnce = async (requestAdapter: ProviderAdapter, recovery?: AttemptRecoveryKind): Promise<IterationResponse> => {
455459
let request: AdapterRequest;
456460
if (cachedRequest !== undefined && cachedAdapter === requestAdapter) {

‎src/lib/upstream-retry.ts‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -98,6 +98,10 @@ export async function releaseResponseBodyBestEffort(
9898
}
9999
await new Promise<void>(resolve => {
100100
let timer: ReturnType<typeof setTimeout>;
101+
/**
102+
* Abort hook: clear the bounded-body release timer and settle the promise so a
103+
* never-settling cancel() can never block the abort-aware backoff.
104+
*/
101105
const onAbort = () => {
102106
clearTimeout(timer);
103107
resolve();

‎src/web-search/loop.ts‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -350,6 +350,10 @@ export async function runWithWebSearch(deps: WebSearchLoopDeps): Promise<Respons
350350
*/
351351
let cachedRequest: AdapterRequest | undefined;
352352
let cachedAdapter: ProviderAdapter | undefined;
353+
/**
354+
* Build and fetch one web-search iteration on the given adapter, under the iteration
355+
* header deadline. The caller owns same-target 429 replays and key rotation around it.
356+
*/
353357
const fetchOnce = async (requestAdapter: ProviderAdapter, recovery?: AttemptRecoveryKind): Promise<IterationResponse> => {
354358
let request: AdapterRequest;
355359
if (cachedRequest !== undefined && cachedAdapter === requestAdapter) {

0 commit comments

Comments
 (0)