@crawlee/browser

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 BrowserCrawler uses 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 requestList or requestQueue constructor options, respectively. If neither requestList nor requestQueue options are provided, the crawler will open the default request queue either when the crawler.addRequests() function is called, or if requests parameter (representing the initial requests) of the crawler.run() function is provided.

If both requestList and requestQueue options 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.

BrowserCrawler opens a new browser page (i.e. tab or window) for each Request object to crawl and then calls the function provided by user as the requestHandler option.

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 autoscaledPoolOptions parameter of the BrowserCrawler constructor. For user convenience, the minConcurrency and maxConcurrency options of the underlying AutoscaledPool constructor are available directly in the BrowserCrawler constructor.

NOTE: the pool of browser instances is internally managed by the BrowserPool class.

Index

Crawlers

• BrowserCrawler

Other

• AddRequestsBatchedOptions
• AddRequestsBatchedResult
• AutoscaledPool
• AutoscaledPoolOptions
• BASIC_CRAWLER_TIMEOUT_BUFFER_SECS
• BLOCKED_STATUS_CODES
• BasicCrawler
• BasicCrawlerOptions
• BasicCrawlingContext
• ClientInfo
• Configuration
• ConfigurationOptions
• Cookie
• CrawlerAddRequestsOptions
• CrawlerAddRequestsResult
• CrawlerExperiments
• CrawlerRunOptions
• CrawlingContext
• CreateContextOptions
• CreateSession
• CriticalError
• Dataset
• DatasetConsumer
• DatasetContent
• DatasetDataOptions
• DatasetExportOptions
• DatasetExportToOptions
• DatasetIteratorOptions
• DatasetMapper
• DatasetOptions
• DatasetReducer
• EnqueueLinksOptions
• EnqueueStrategy
• ErrnoException
• ErrorHandler
• ErrorSnapshotter
• ErrorTracker
• ErrorTrackerOptions
• EventManager
• EventType
• EventTypeName
• FinalStatistics
• GetUserDataFromRequest
• GlobInput
• GlobObject
• IRequestList
• IStorage
• KeyConsumer
• KeyValueStore
• KeyValueStoreIteratorOptions
• KeyValueStoreOptions
• LoadedRequest
• LocalEventManager
• Log
• LogLevel
• Logger
• LoggerJson
• LoggerOptions
• LoggerText
• MAX_POOL_SIZE
• NonRetryableError
• PERSIST_STATE_KEY
• PersistenceOptions
• ProxyConfiguration
• ProxyConfigurationFunction
• ProxyConfigurationOptions
• ProxyInfo
• PseudoUrl
• PseudoUrlInput
• PseudoUrlObject
• PushErrorMessageOptions
• QueueOperationInfo
• RecordOptions
• RegExpInput
• RegExpObject
• Request
• RequestHandler
• RequestHandlerResult
• RequestList
• RequestListOptions
• RequestListSourcesFunction
• RequestListState
• RequestOptions
• RequestProvider
• RequestProviderOptions
• RequestQueue
• RequestQueueOperationOptions
• RequestQueueOptions
• RequestQueueV1
• RequestQueueV2
• RequestState
• RequestTransform
• RestrictedCrawlingContext
• RetryRequestError
• Router
• RouterHandler
• RouterRoutes
• Session
• SessionError
• SessionOptions
• SessionPool
• SessionPoolOptions
• SessionState
• SitemapRequestList
• SitemapRequestListOptions
• SnapshotResult
• Snapshotter
• SnapshotterOptions
• Source
• StatisticPersistedState
• StatisticState
• Statistics
• StatisticsOptions
• StatusMessageCallback
• StatusMessageCallbackParams
• StorageClient
• StorageManagerOptions
• SystemInfo
• SystemStatus
• SystemStatusOptions
• TieredProxy
• UrlPatternObject
• UseStateOptions
• checkStorageAccess
• createBasicRouter
• enqueueLinks
• filterRequestsByPatterns
• log
• purgeDefaultStorages
• tryAbsoluteURL
• useState
• withCheckedStorageAccess
• BrowserCrawlerOptions
• BrowserCrawlingContext
• BrowserLaunchContext
• BrowserErrorHandler
• BrowserHook
• BrowserRequestHandler

Other

AddRequestsBatchedOptions

Re-exports AddRequestsBatchedOptions

AddRequestsBatchedResult

Re-exports AddRequestsBatchedResult

AutoscaledPool

Re-exports AutoscaledPool

AutoscaledPoolOptions

Re-exports AutoscaledPoolOptions

BASIC_CRAWLER_TIMEOUT_BUFFER_SECS

Re-exports BASIC_CRAWLER_TIMEOUT_BUFFER_SECS

BLOCKED_STATUS_CODES

Re-exports BLOCKED_STATUS_CODES

BasicCrawler

Re-exports BasicCrawler

BasicCrawlerOptions

Re-exports BasicCrawlerOptions

BasicCrawlingContext

Re-exports BasicCrawlingContext

ClientInfo

Re-exports ClientInfo

Configuration

Re-exports Configuration

ConfigurationOptions

Re-exports ConfigurationOptions

Cookie

Re-exports Cookie

CrawlerAddRequestsOptions

Re-exports CrawlerAddRequestsOptions

CrawlerAddRequestsResult

Re-exports CrawlerAddRequestsResult

CrawlerExperiments

Re-exports CrawlerExperiments

CrawlerRunOptions

Re-exports CrawlerRunOptions

CrawlingContext

Re-exports CrawlingContext

CreateContextOptions

Re-exports CreateContextOptions

CreateSession

Re-exports CreateSession

CriticalError

Re-exports CriticalError

Dataset

Re-exports Dataset

DatasetConsumer

Re-exports DatasetConsumer

DatasetContent

Re-exports DatasetContent

DatasetDataOptions

Re-exports DatasetDataOptions

DatasetExportOptions

Re-exports DatasetExportOptions

DatasetExportToOptions

Re-exports DatasetExportToOptions

DatasetIteratorOptions

Re-exports DatasetIteratorOptions

DatasetMapper

Re-exports DatasetMapper

DatasetOptions

Re-exports DatasetOptions

DatasetReducer

Re-exports DatasetReducer

EnqueueLinksOptions

Re-exports EnqueueLinksOptions

EnqueueStrategy

Re-exports EnqueueStrategy

ErrnoException

Re-exports ErrnoException

ErrorHandler

Re-exports ErrorHandler

ErrorSnapshotter

Re-exports ErrorSnapshotter

ErrorTracker

Re-exports ErrorTracker

ErrorTrackerOptions

Re-exports ErrorTrackerOptions

EventManager

Re-exports EventManager

EventType

Re-exports EventType

EventTypeName

Re-exports EventTypeName

FinalStatistics

Re-exports FinalStatistics

GetUserDataFromRequest

Re-exports GetUserDataFromRequest

GlobInput

Re-exports GlobInput

GlobObject

Re-exports GlobObject

IRequestList

Re-exports IRequestList

IStorage

Re-exports IStorage

KeyConsumer

Re-exports KeyConsumer

KeyValueStore

Re-exports KeyValueStore

KeyValueStoreIteratorOptions

Re-exports KeyValueStoreIteratorOptions

KeyValueStoreOptions

Re-exports KeyValueStoreOptions

LoadedRequest

Re-exports LoadedRequest

LocalEventManager

Re-exports LocalEventManager

Log

Re-exports Log

LogLevel

Re-exports LogLevel

Logger

Re-exports Logger

LoggerJson

Re-exports LoggerJson

LoggerOptions

Re-exports LoggerOptions

LoggerText

Re-exports LoggerText

MAX_POOL_SIZE

Re-exports MAX_POOL_SIZE

NonRetryableError

Re-exports NonRetryableError

PERSIST_STATE_KEY

Re-exports PERSIST_STATE_KEY

PersistenceOptions

Re-exports PersistenceOptions

ProxyConfiguration

Re-exports ProxyConfiguration

ProxyConfigurationFunction

Re-exports ProxyConfigurationFunction

ProxyConfigurationOptions

Re-exports ProxyConfigurationOptions

ProxyInfo

Re-exports ProxyInfo

PseudoUrl

Re-exports PseudoUrl

PseudoUrlInput

Re-exports PseudoUrlInput

PseudoUrlObject

Re-exports PseudoUrlObject

PushErrorMessageOptions

Re-exports PushErrorMessageOptions

QueueOperationInfo

Re-exports QueueOperationInfo

RecordOptions

Re-exports RecordOptions

RegExpInput

Re-exports RegExpInput

RegExpObject

Re-exports RegExpObject

Request

Re-exports Request

RequestHandler

Re-exports RequestHandler

RequestHandlerResult

Re-exports RequestHandlerResult

RequestList

Re-exports RequestList

RequestListOptions

Re-exports RequestListOptions

RequestListSourcesFunction

Re-exports RequestListSourcesFunction

RequestListState

Re-exports RequestListState

RequestOptions

Re-exports RequestOptions

RequestProvider

Re-exports RequestProvider

RequestProviderOptions

Re-exports RequestProviderOptions

RequestQueue

Re-exports RequestQueue

RequestQueueOperationOptions

Re-exports RequestQueueOperationOptions

RequestQueueOptions

Re-exports RequestQueueOptions

RequestQueueV1

Re-exports RequestQueueV1

RequestQueueV2

Re-exports RequestQueueV2

RequestState

Re-exports RequestState

RequestTransform

Re-exports RequestTransform

RestrictedCrawlingContext

Re-exports RestrictedCrawlingContext

RetryRequestError

Re-exports RetryRequestError

Router

Re-exports Router

RouterHandler

Re-exports RouterHandler

RouterRoutes

Re-exports RouterRoutes

Session

Re-exports Session

SessionError

Re-exports SessionError

SessionOptions

Re-exports SessionOptions

SessionPool

Re-exports SessionPool

SessionPoolOptions

Re-exports SessionPoolOptions

SessionState

Re-exports SessionState

SitemapRequestList

Re-exports SitemapRequestList

SitemapRequestListOptions

Re-exports SitemapRequestListOptions

SnapshotResult

Re-exports SnapshotResult

Snapshotter

Re-exports Snapshotter

SnapshotterOptions

Re-exports SnapshotterOptions

Source

Re-exports Source

StatisticPersistedState

Re-exports StatisticPersistedState

StatisticState

Re-exports StatisticState

Statistics

Re-exports Statistics

StatisticsOptions

Re-exports StatisticsOptions

StatusMessageCallback

Re-exports StatusMessageCallback

StatusMessageCallbackParams

Re-exports StatusMessageCallbackParams

StorageClient

Re-exports StorageClient

StorageManagerOptions

Re-exports StorageManagerOptions

SystemInfo

Re-exports SystemInfo

SystemStatus

Re-exports SystemStatus

SystemStatusOptions

Re-exports SystemStatusOptions

TieredProxy

Re-exports TieredProxy

UrlPatternObject

Re-exports UrlPatternObject

UseStateOptions

Re-exports UseStateOptions

checkStorageAccess

Re-exports checkStorageAccess

createBasicRouter

Re-exports createBasicRouter

enqueueLinks

Re-exports enqueueLinks

filterRequestsByPatterns

Re-exports filterRequestsByPatterns

log

Re-exports log

purgeDefaultStorages

Re-exports purgeDefaultStorages

tryAbsoluteURL

Re-exports tryAbsoluteURL

useState

Re-exports useState

withCheckedStorageAccess

Re-exports withCheckedStorageAccess

BrowserErrorHandler

BrowserErrorHandler<Context>: ErrorHandler<Context>

Type parameters

• Context: BrowserCrawlingContext = BrowserCrawlingContext

BrowserHook

BrowserHook<Context, GoToOptions>: (crawlingContext: Context, gotoOptions: GoToOptions) => Awaitable<void>

Type parameters

• Context = BrowserCrawlingContext
• GoToOptions: Dictionary | undefined = Dictionary

Type declaration

• • (crawlingContext: Context, gotoOptions: GoToOptions): Awaitable<void>

  • Parameters

    • crawlingContext: Context

    • gotoOptions: GoToOptions

    Returns Awaitable<void>

BrowserRequestHandler

BrowserRequestHandler<Context>: RequestHandler<Context>

Type parameters

• Context: BrowserCrawlingContext = BrowserCrawlingContext