Skip to main content
Version: Next

AdaptivePlaywrightCrawler

experimental

An extension of PlaywrightCrawler that uses a more limited request handler interface so that it is able to switch to HTTP-only crawling when it detects it may be possible.

Example usage:

const crawler = new AdaptivePlaywrightCrawler({
renderingTypeDetectionRatio: 0.1,
async requestHandler({ querySelector, pushData, enqueueLinks, request, log }) {
// This function is called to extract data from a single web page
const $prices = await querySelector('span.price')

await pushData({
url: request.url,
price: $prices.filter(':contains("$")').first().text(),
})

await enqueueLinks({ selector: '.pagination a' })
},
});

await crawler.run([
'http://www.example.com/page-1',
'http://www.example.com/page-2',
]);

Hierarchy

Index

Constructors

constructor

Properties

optionalautoscaledPool

autoscaledPool?: AutoscaledPool

A reference to the underlying AutoscaledPool class that manages the concurrency of the crawler.

NOTE: This property is only initialized after calling the crawler.run() function. We can use it to change the concurrency settings on the fly, to pause the crawler by calling autoscaledPool.pause() or to abort it by calling autoscaledPool.abort().

browserPool

browserPool: BrowserPool<{ browserPlugins: [PlaywrightPlugin] }, [PlaywrightPlugin], BrowserController<BrowserType<{}>, undefined | LaunchOptions, Browser, undefined | { acceptDownloads?: boolean; baseURL?: string; bypassCSP?: boolean; clientCertificates?: { cert?: Buffer; certPath?: string; key?: Buffer; keyPath?: string; origin: string; passphrase?: string; pfx?: Buffer; pfxPath?: string }[]; colorScheme?: null | light | dark | no-preference; deviceScaleFactor?: number; extraHTTPHeaders?: {}; forcedColors?: null | active | none; geolocation?: { accuracy?: number; latitude: number; longitude: number }; hasTouch?: boolean; httpCredentials?: { origin?: string; password: string; send?: unauthorized | always; username: string }; ignoreHTTPSErrors?: boolean; isMobile?: boolean; javaScriptEnabled?: boolean; locale?: string; logger?: Logger; offline?: boolean; permissions?: string[]; proxy?: { bypass?: string; password?: string; server: string; username?: string }; recordHar?: { content?: omit | embed | attach; mode?: full | minimal; omitContent?: boolean; path: string; urlFilter?: string | RegExp }; recordVideo?: { dir: string; size?: { height: number; width: number } }; reducedMotion?: null | reduce | no-preference; screen?: { height: number; width: number }; serviceWorkers?: allow | block; storageState?: string | { cookies: { domain: string; expires: number; httpOnly: boolean; name: string; path: string; sameSite: Strict | Lax | None; secure: boolean; value: string }[]; origins: { localStorage: { name: string; value: string }[]; origin: string }[] }; strictSelectors?: boolean; timezoneId?: string; userAgent?: string; videoSize?: { height: number; width: number }; videosPath?: string; viewport?: null | { height: number; width: number } }, Page>, LaunchContext<BrowserType<{}>, undefined | LaunchOptions, Browser, undefined | { acceptDownloads?: boolean; baseURL?: string; bypassCSP?: boolean; clientCertificates?: { cert?: Buffer; certPath?: string; key?: Buffer; keyPath?: string; origin: string; passphrase?: string; pfx?: Buffer; pfxPath?: string }[]; colorScheme?: null | light | dark | no-preference; deviceScaleFactor?: number; extraHTTPHeaders?: {}; forcedColors?: null | active | none; geolocation?: { accuracy?: number; latitude: number; longitude: number }; hasTouch?: boolean; httpCredentials?: { origin?: string; password: string; send?: unauthorized | always; username: string }; ignoreHTTPSErrors?: boolean; isMobile?: boolean; javaScriptEnabled?: boolean; locale?: string; logger?: Logger; offline?: boolean; permissions?: string[]; proxy?: { bypass?: string; password?: string; server: string; username?: string }; recordHar?: { content?: omit | embed | attach; mode?: full | minimal; omitContent?: boolean; path: string; urlFilter?: string | RegExp }; recordVideo?: { dir: string; size?: { height: number; width: number } }; reducedMotion?: null | reduce | no-preference; screen?: { height: number; width: number }; serviceWorkers?: allow | block; storageState?: string | { cookies: { domain: string; expires: number; httpOnly: boolean; name: string; path: string; sameSite: Strict | Lax | None; secure: boolean; value: string }[]; origins: { localStorage: { name: string; value: string }[]; origin: string }[] }; strictSelectors?: boolean; timezoneId?: string; userAgent?: string; videoSize?: { height: number; width: number }; videosPath?: string; viewport?: null | { height: number; width: number } }, Page>, undefined | { acceptDownloads?: boolean; baseURL?: string; bypassCSP?: boolean; clientCertificates?: { cert?: Buffer; certPath?: string; key?: Buffer; keyPath?: string; origin: string; passphrase?: string; pfx?: Buffer; pfxPath?: string }[]; colorScheme?: null | light | dark | no-preference; deviceScaleFactor?: number; extraHTTPHeaders?: {}; forcedColors?: null | active | none; geolocation?: { accuracy?: number; latitude: number; longitude: number }; hasTouch?: boolean; httpCredentials?: { origin?: string; password: string; send?: unauthorized | always; username: string }; ignoreHTTPSErrors?: boolean; isMobile?: boolean; javaScriptEnabled?: boolean; locale?: string; logger?: Logger; offline?: boolean; permissions?: string[]; proxy?: { bypass?: string; password?: string; server: string; username?: string }; recordHar?: { content?: omit | embed | attach; mode?: full | minimal; omitContent?: boolean; path: string; urlFilter?: string | RegExp }; recordVideo?: { dir: string; size?: { height: number; width: number } }; reducedMotion?: null | reduce | no-preference; screen?: { height: number; width: number }; serviceWorkers?: allow | block; storageState?: string | { cookies: { domain: string; expires: number; httpOnly: boolean; name: string; path: string; sameSite: Strict | Lax | None; secure: boolean; value: string }[]; origins: { localStorage: { name: string; value: string }[]; origin: string }[] }; strictSelectors?: boolean; timezoneId?: string; userAgent?: string; videoSize?: { height: number; width: number }; videosPath?: string; viewport?: null | { height: number; width: number } }, Page>

A reference to the underlying BrowserPool class that manages the crawler's browsers.

readonlyconfig

config: Configuration = ...

hasFinishedBefore

hasFinishedBefore: boolean = false

launchContext

launchContext: BrowserLaunchContext<LaunchOptions, unknown>

readonlylog

log: Log

optionalproxyConfiguration

proxyConfiguration?: ProxyConfiguration

A reference to the underlying ProxyConfiguration class that manages the crawler's proxies. Only available if used by the crawler.

optionalrequestList

requestList?: IRequestList

A reference to the underlying RequestList class that manages the crawler's requests. Only available if used by the crawler.

optionalrequestQueue

requestQueue?: RequestProvider

Dynamic queue of URLs to be processed. This is useful for recursive crawling of websites. A reference to the underlying RequestQueue class that manages the crawler's requests. Only available if used by the crawler.

readonlyrouter

Default Router instance that will be used if we don't specify any requestHandler. See router.addHandler() and router.addDefaultHandler().

running

running: boolean = false

optionalsessionPool

sessionPool?: SessionPool

A reference to the underlying SessionPool class that manages the crawler's sessions. Only available if used by the crawler.

readonlystats

stats: AdaptivePlaywrightCrawlerStatistics

A reference to the underlying Statistics class that collects and logs run statistics for requests.

Methods

addRequests

  • Adds requests to the queue in batches. By default, it will resolve after the initial batch is added, and continue adding the rest in background. You can configure the batch size via batchSize option and the sleep time in between the batches via waitBetweenBatchesMillis. If you want to wait for all batches to be added to the queue, you can use the waitForAllRequestsToBeAdded promise you get in the response object.

    This is an alias for calling addRequestsBatched() on the implicit RequestQueue for this crawler instance.


    Parameters

    Returns Promise<CrawlerAddRequestsResult>

exportData

  • exportData<Data>(path: string, format?: json | csv, options?: DatasetExportOptions): Promise<Data[]>
  • Retrieves all the data from the default crawler Dataset and exports them to the specified format. Supported formats are currently 'json' and 'csv', and will be inferred from the path automatically.


    Type parameters

    • Data

    Parameters

    Returns Promise<Data[]>

getData

getDataset

  • getDataset(idOrName?: string): Promise<Dataset<Dictionary>>
  • Retrieves the specified Dataset, or the default crawler Dataset.


    Parameters

    • optionalidOrName: string

    Returns Promise<Dataset<Dictionary>>

getRequestQueue

  • Returns Promise<RequestProvider>

pushData

  • pushData(data: Dictionary | Dictionary[], datasetIdOrName?: string): Promise<void>
  • Pushes data to the specified Dataset, or the default crawler Dataset by calling Dataset.pushData.


    Parameters

    • data: Dictionary | Dictionary[]
    • optionaldatasetIdOrName: string

    Returns Promise<void>

run

  • Runs the crawler. Returns a promise that gets resolved once all the requests are processed. We can use the requests parameter to enqueue the initial requests - it is a shortcut for running crawler.addRequests() before the crawler.run().


    Parameters

    Returns Promise<FinalStatistics>

setStatusMessage

  • This method is periodically called by the crawler, every statusMessageLoggingInterval seconds.


    Parameters

    Returns Promise<void>

useState

  • useState<State>(defaultValue?: State): Promise<State>
  • Type parameters

    • State: Dictionary = Dictionary

    Parameters

    • defaultValue: State = ...

    Returns Promise<State>