abstractBrowserCrawler <InternalBrowserPoolOptions, LaunchOptions, Context, GoToOptions>
Hierarchy
- BasicCrawler<Context>
- BrowserCrawler
Index
Properties
optionalautoscaledPool
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 callingautoscaledPool.pause()or to abort it by callingautoscaledPool.abort().
browserPool
A reference to the underlying BrowserPool class that manages the crawler's browsers.
readonlyconfig
launchContext
optionalproxyConfiguration
A reference to the underlying ProxyConfiguration class that manages the crawler's proxies. Only available if used by the crawler.
optionalrequestList
A reference to the underlying RequestList class that manages the crawler's requests. Only available if used by the crawler.
optionalrequestQueue
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().
optionalrunning
optionalsessionPool
A reference to the underlying SessionPool class that manages the crawler's sessions. Only available if used by the crawler.
readonlystats
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
batchSizeoption and the sleep time in between the batches viawaitBetweenBatchesMillis. If you want to wait for all batches to be added to the queue, you can use thewaitForAllRequestsToBeAddedpromise you get in the response object.Parameters
requests: (string | Source)[]
The requests to add
options: CrawlerAddRequestsOptions = {}
Options for the request queue
Returns Promise<CrawlerAddRequestsResult>
exportData
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
pathautomatically.Type parameters
- Data
Parameters
path: string
optionalformat: json | csv
optionaloptions: DatasetExportOptions
Returns Promise<Data[]>
getData
Retrieves data from the default crawler Dataset by calling Dataset.getData.
Parameters
rest...args: [options: DatasetDataOptions]
Returns Promise<DatasetContent<Dictionary>>
getDataset
getRequestQueue
Returns Promise<RequestProvider>
pushData
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
requestsparameter to enqueue the initial requests - it is a shortcut for runningcrawler.addRequests()before thecrawler.run().Parameters
optionalrequests: (string | Request<Dictionary> | RequestOptions<Dictionary>)[]
The requests to add
optionaloptions: CrawlerRunOptions
Options for the request queue
Returns Promise<FinalStatistics>
setStatusMessage
This method is periodically called by the crawler, every
statusMessageLoggingIntervalseconds.Parameters
message: string
options: SetStatusMessageOptions = {}
Returns Promise<void>
useState
Type parameters
- State: Dictionary = Dictionary
Parameters
defaultValue: State = ...
Returns Promise<State>
Provides a simple framework for parallel crawling of web pages using headless browsers with Puppeteer and Playwright. The URLs to crawl are fed either from a static list of URLs or from a dynamic queue of URLs enabling recursive crawling of websites.
Since
BrowserCrawleruses headless (or even headful) browsers to download web pages and extract data, it is useful for crawling of websites that require to execute JavaScript. If the target website doesn't need JavaScript, we should consider using the CheerioCrawler, which downloads the pages using raw HTTP requests and is about 10x faster.The source URLs are represented by the Request objects that are fed from the RequestList or RequestQueue instances provided by the
requestListorrequestQueueconstructor options, respectively. If neitherrequestListnorrequestQueueoptions are provided, the crawler will open the default request queue either when thecrawler.addRequests()function is called, or ifrequestsparameter (representing the initial requests) of thecrawler.run()function is provided.If both
requestListandrequestQueueoptions are used, the instance first processes URLs from the RequestList and automatically enqueues all of them to the RequestQueue before it starts their processing. This ensures that a single URL is not crawled multiple times.The crawler finishes when there are no more Request objects to crawl.
BrowserCrawleropens a new browser page (i.e. tab or window) for each Request object to crawl and then calls the function provided by user as therequestHandleroption.New pages are only opened when there is enough free CPU and memory available, using the functionality provided by the AutoscaledPool class. All AutoscaledPool configuration options can be passed to the
autoscaledPoolOptionsparameter of theBrowserCrawlerconstructor. For user convenience, theminConcurrencyandmaxConcurrencyoptions of the underlying AutoscaledPool constructor are available directly in theBrowserCrawlerconstructor.