Interface: ScrapperBaseConfig<P, R, A>
Defined in: src/batteries/tools/scrapper/shared.ts:179
Configuration common to every Scrapper factory. A is the accepted artifact resolver type.
Type Parameters
| Type Parameter |
|---|
P |
R |
A |
Properties
| Property | Type | Description | Defined in |
|---|---|---|---|
artifact? | A | Spool-artifact resolver for the output. Default () => SpooledJsonArtifact. | src/batteries/tools/scrapper/shared.ts:189 |
defaults? | Partial<P> | Model-overridable default param values. | src/batteries/tools/scrapper/shared.ts:197 |
description? | string | Tool description override. | src/batteries/tools/scrapper/shared.ts:193 |
fixed? | Partial<P> | Pinned params — sent always, removed from the model schema. | src/batteries/tools/scrapper/shared.ts:195 |
fixedQuery? | Record<string, string> | Raw, un-modeled wire params (kebab keys) — always sent, never model-visible. Keeps the battery generic. | src/batteries/tools/scrapper/shared.ts:199 |
gate? | ToolGateFn | Optional per-call gate run before the HTTP request — the seam for human-approval/RBAC flows built on ctx.waitFor (the ADK gates primitive). Throwing aborts the call through the standard tool-error path. Scraping reaches the network on the agent's behalf, which makes every call a candidate for gating. | src/batteries/tools/scrapper/shared.ts:206 |
headers? | | ToolHeadersResolver | ToolHeaders | Headers sent to the Scrapper INSTANCE for auth (X-API-Key / Basic) — static or resolver. | src/batteries/tools/scrapper/shared.ts:183 |
inputPipeline? | ScrapperInputMiddlewareFn[] | Stages run before the HTTP request. See ScrapperRequestContext. | src/batteries/tools/scrapper/shared.ts:208 |
instanceUrl | string | Base URL of the Scrapper instance, e.g. https://scrapper.example.org. Required. | src/batteries/tools/scrapper/shared.ts:181 |
name? | string | Tool name override. | src/batteries/tools/scrapper/shared.ts:191 |
outputPipeline? | ScrapperOutputMiddlewareFn<R>[] | Stages run after the response is parsed. See ScrapperResponseContext. | src/batteries/tools/scrapper/shared.ts:210 |
requestTimeoutMs? | number | The tool's own fetch AbortController timeout in ms. Default 65_000 (> Scrapper's 60s browser default). | src/batteries/tools/scrapper/shared.ts:185 |
resultFormat? | "raw" | "normalized" | "either" | Output shape. normalized/raw pin it; either (default) exposes a format arg to the model. | src/batteries/tools/scrapper/shared.ts:187 |