Skip to main content
Version: Next

BasicCrawler <Context, ContextExtension, ExtendedContext, Routes, StatisticStateExtension>

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • new BasicCrawler<Context, ContextExtension, ExtendedContext, Routes, StatisticStateExtension>(options): BasicCrawler<Context, ContextExtension, ExtendedContext, Routes, StatisticStateExtension>

Properties

hasFinishedBefore

hasFinishedBefore: boolean = false

optionalreadonlyproxyConfiguration

proxyConfiguration?: IProxyConfiguration

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

readonlyrouter

router: RouterHandler<Context, Routes> = ...

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

running

running: boolean = false

Accessors

basicContextPipeline

  • The basic part of the context pipeline. Unlike the subclass pipeline, this part has no major side effects (e.g. launching a browser). It also makes typing more explicit, as subclass pipelines expect the basic crawler fields to already be present in the context at runtime.

    Context built with this pipeline can be passed into multiple crawler pipelines at once. This is used e.g. in the AdaptivePlaywrightCrawler.

    Returns ContextPipeline<{ request: CrawleeRequest<Dictionary> }, CrawlingContext<Dictionary>>

concurrencySystem

  • The concurrency governor this run is booking its requests against — either the concurrencySystem that was injected, or the default the crawler built for itself. Read it for telemetry: desiredConcurrency, currentConcurrency, isRunning.

    NOTE: undefined until crawler.run() has resolved it. A crawler-owned default is also rebuilt for every run, so the instance is not stable across runs.

    IConcurrencySystem is deliberately read-only. Tuning concurrency while a crawl is running means owning the instance: build a ConcurrencySystem yourself and inject it, then set minConcurrency/maxConcurrency/desiredConcurrency on your own reference.

    Returns undefined | IConcurrencySystem

contextPipeline

log

sessionPool

  • A reference to the underlying session pool that manages the crawler's sessions. Typed as ISessionPool so custom implementations can be plugged in via the sessionPool constructor option.

    Returns ISessionPool

statistics

  • The statistics instance collecting the crawler's run statistics - either the injected statistics option or a crawler-built default. Typed as IStatistics so custom implementations can be plugged in.

    Returns IStatistics<StatisticStateExtension>

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.

    Optionally, the requests can be filtered using include/exclude glob or regexp patterns and an enqueue strategy (both AND-ed together, same as enqueueLinks), relative to baseUrl. Unlike enqueueLinks, there is no implicit "current page" to anchor the strategy to, so strategy defaults to all here.

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

    Parameters

    • requests: ReadonlyDeep<TypedRequestsLike<Routes>>

      The requests to add

    • options: CrawlerAddRequestsOptions = {}

      Options for the request queue

    Returns Promise<CrawlerAddRequestsResult>

exportData

  • exportData<Data>(path, format, options): 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.

    Parameters

    Returns Promise<Data[]>

getData

getDataset

getRequestManager

getRequestQueue

pause

  • pause(timeoutSecs): Promise<void>

  • Stops dispatching new requests, letting the in-progress ones finish. Resolves once they have settled, or rejects after timeoutSecs if they take too long. Unlike stop(), this does not end the run — run() stays pending until resume().

    NOTE: The concurrency system keeps monitoring and autoscaling throughout, since a shared one may still be serving other crawlers.

    Parameters

    • optionaltimeoutSecs: number

    Returns Promise<void>

pushData

  • pushData(data, datasetIdentifier): Promise<void>

resume

  • resume(): void

  • Resumes a run suspended with pause(), letting the crawler dispatch requests again. A no-op on a crawler that is not paused.

    Returns void

run

  • Runs the crawler. Returns a promise that resolves once every request has been processed and the crawler's finished-check (taskLoopOptions.isFinishedFunction, or the default "the request manager is empty") reports that the crawl is over.

    We can use the requests parameter to enqueue the initial requests — it is a shortcut for running crawler.addRequests() before crawler.run().

    Parameters

    • optionalrequests: TypedRequestsLike<Routes>

      The requests to add.

    • optionaloptions: CrawlerRunOptions

      Options for the request queue.

    Returns Promise<FinalStatistics>

setStatusMessage

  • setStatusMessage(message, options): void

  • Sets the status message for the current crawler run.

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

    The message is logged and broadcast via the statusMessage event. Integrations such as the Apify SDK subscribe to that event and forward the message to their status-reporting backend (e.g. the Apify platform).

    Parameters

    Returns void

stop

  • stop(reason): void

  • Gracefully stops the current run of the crawler.

    All the tasks active at the time of calling this method will be allowed to finish.

    To stop the crawler immediately, use crawler.teardown() instead.

    Parameters

    • reason: string = 'The crawler has been gracefully stopped.'

    Returns void

teardown

  • teardown(): Promise<void>

  • Stops the crawler immediately.

    This method doesn't wait for currently active requests to finish.

    To stop the crawler gracefully (waiting for all running requests to finish), use crawler.stop() instead.

    Returns Promise<void>

useState

  • useState<State>(defaultValue): Promise<State>

  • Parameters

    • defaultValue: State = ...

    Returns Promise<State>

Page Options