Skip to content

Crawlee—A web scraping and browser automation library for Node.js to build reliable crawlers. In JavaScript and TypeScript. Extract data for AI, LLMs, RAG, or GPTs. Download HTML, PDF, JPG, PNG, and other files from websites. Works with Puppeteer, Playwright, Cheerio, JSDOM, and raw HTTP. Both headful and headless mode. With proxy rotation.

fix: add `headless` option to `BrowserCrawlerOptions` (#1412)

Martin Adámek7896839dee7a
diff --git a/packages/browser-crawler/src/internals/browser-crawler.ts b/packages/browser-crawler/src/internals/browser-crawler.ts
index 5bb711e4d..3e4990ace 100644
--- a/packages/browser-crawler/src/internals/browser-crawler.ts
+++ b/packages/browser-crawler/src/internals/browser-crawler.ts
@@ -248,6 +248,12 @@ export interface BrowserCrawlerOptions<
* This can only be used when `useSessionPool` is set to `true`.
*/
persistCookiesPerSession?: boolean;
+
+ /**
+ * Whether to run browser in headless mode. Defaults to `true`.
+ * Can be also set via {@link Configuration}.
+ */
+ headless?: boolean;
}
/**
@@ -306,7 +312,7 @@ export abstract class BrowserCrawler<
*/
browserPool: BrowserPool<InternalBrowserPoolOptions>;
- launchContext?: BrowserLaunchContext<LaunchOptions, unknown>;
+ launchContext: BrowserLaunchContext<LaunchOptions, unknown>;
protected userProvidedRequestHandler!: BrowserCrawlerHandleRequest<Context>;
protected navigationTimeoutMillis: number;
@@ -340,7 +346,7 @@ export abstract class BrowserCrawler<
requestHandlerTimeoutSecs = 60,
persistCookiesPerSession,
proxyConfiguration,
- launchContext,
+ launchContext = {},
browserPoolOptions,
preNavigationHooks = [],
postNavigationHooks = [],
@@ -352,6 +358,7 @@ export abstract class BrowserCrawler<
failedRequestHandler,
handleFailedRequestFunction,
+ headless,
...basicCrawlerOptions
} = options;
@@ -394,6 +401,11 @@ export abstract class BrowserCrawler<
this.preNavigationHooks = preNavigationHooks;
this.postNavigationHooks = postNavigationHooks;
+ if (headless != null) {
+ this.launchContext.launchOptions ??= {} as LaunchOptions;
+ (this.launchContext.launchOptions as Dictionary).headless = headless;
+ }
+
if (this.useSessionPool) {
this.persistCookiesPerSession = persistCookiesPerSession !== undefined ? persistCookiesPerSession : true;
} else {