Skip to content

Commit 116d65d

Browse files
committed
DOC: Autogenerate and update documentation
1 parent f5e7933 commit 116d65d

3 files changed

Lines changed: 10 additions & 3 deletions

File tree

docs/helpers/CDPBrowser.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -515,7 +515,10 @@ Returns **[string][2]** the resolved, absolute URL.
515515

516516
Settles after an interaction (click, key press, etc.) before the next step runs, using the
517517
listener `_armActionSettle` started *before* the interaction was dispatched (`armed`; a fresh
518-
one is armed here too, as a safety net, if a call site forgot to).
518+
one is armed here too, as a safety net, if a call site forgot to — but arming this late can
519+
only miss a navigation that already started during the action's own dispatch, exactly the race
520+
this design exists to avoid, so every call site should pass its own pre-armed `armed`, not rely
521+
on this fallback).
519522

520523
If `options.waitForAction` was set explicitly in the config, honors it literally as a fixed
521524
pacing sleep, exactly as before this round — an explicit value is a deliberate choice

docs/helpers/Kitesurf.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,9 @@ Type: [object][5]
9393

9494
Closes the target as `CDPBrowser._finishTest` does, then releases the cloud session acquired
9595
in `_resolveEndpoint` via the Cloudflare API so it does not linger for the full `keepAlive`
96-
window.
96+
window. The release runs in a `finally` so a rejection while closing the CDP connection still
97+
frees the cloud session instead of leaving the browser alive until `keepAlive` expires; the
98+
session id is cleared before the request, so a repeated call never releases it twice.
9799

98100
### _resolveEndpoint
99101

docs/helpers/Obscura.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -176,7 +176,9 @@ Returns **[Promise][2]<[boolean][5]>** true if the URL answered.
176176
### _resolveBinary
177177

178178
Resolves the `obscura` binary to spawn, in priority order: `options.binaryPath`, then the
179-
`OBSCURA_PATH` environment variable, then `obscura` on `PATH` (via `which`).
179+
`OBSCURA_PATH` environment variable, then `obscura` on `PATH`. The `PATH` lookup walks the
180+
directories itself instead of shelling out to `which`, which does not exist on Windows: on
181+
Windows every `PATHEXT` suffix is tried, so an `obscura.exe` on `PATH` is found too.
180182

181183
Returns **([string][4] | null)** an absolute or relative path to the binary, or null if none resolved.
182184

0 commit comments

Comments
 (0)