Skip to content

Commit 4294ed5

Browse files
Document replay frame-filter overrides in API docs
Co-authored-by: Shri Sukhani <shrisukhani@users.noreply.github.com>
1 parent b462177 commit 4294ed5

2 files changed

Lines changed: 10 additions & 0 deletions

File tree

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -527,6 +527,7 @@ const page = await agent.newPage();
527527
const replay = await page.runFromActionCache(cache, {
528528
maxXPathRetries: 3, // Retry XPath resolution up to 3 times before LLM fallback
529529
debug: true,
530+
filterAdTrackingFrames: false, // Optional: include ad/tracking iframes during replay resolution
530531
});
531532

532533
console.log(replay);

src/types/agent/types.ts

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -99,6 +99,9 @@ export interface ActionCacheReplayResult {
9999
export interface RunFromActionCacheParams {
100100
maxXPathRetries?: number;
101101
debug?: boolean;
102+
/**
103+
* Override ad/tracking iframe filtering for this replay.
104+
*/
102105
filterAdTrackingFrames?: boolean;
103106
}
104107

@@ -115,6 +118,9 @@ export interface TaskParams extends AgentExecutionHooks {
115118
enableVisualMode?: boolean;
116119
useDomCache?: boolean;
117120
enableDomStreaming?: boolean;
121+
/**
122+
* Override ad/tracking iframe filtering for this task run.
123+
*/
118124
filterAdTrackingFrames?: boolean;
119125
}
120126

@@ -214,6 +220,9 @@ export interface PerformOptions {
214220
frameIndex?: number | null;
215221
performInstruction?: string | null;
216222
maxSteps?: number;
223+
/**
224+
* Override ad/tracking iframe filtering for this helper replay call.
225+
*/
217226
filterAdTrackingFrames?: boolean;
218227
}
219228

0 commit comments

Comments
 (0)