CrawlingContext <Crawler, UserData>

Hierarchy

• Record<string & {}, unknown>
  • CrawlingContext
    • BasicCrawlingContext
    • BrowserCrawlingContext

Index

Properties

• crawler
• id
• log
• proxyInfo
• request
• session

Methods

• enqueueLinks
• pushData
• sendRequest

Properties

crawler

crawler: Crawler

id

id: string

log

log: Log

optionalproxyInfo

proxyInfo?: ProxyInfo

An object with information about currently used proxy by the crawler and configured by the ProxyConfiguration class.

request

request: Request<UserData>

The original Request object.

optionalsession

session?: Session

Methods

enqueueLinks

• enqueueLinks(options?: EnqueueLinksOptions): Promise<BatchAddRequestsResult>

• This function automatically finds and enqueues links from the current page, adding them to the RequestQueue currently used by the crawler.

  Optionally, the function allows you to filter the target links' URLs using an array of globs or regular expressions and override settings of the enqueued Request objects.

  Check out the Crawl a website with relative links example for more details regarding its usage.

  Example usage

  async requestHandler({ enqueueLinks }) {
      await enqueueLinks({
        globs: [
            'https://www.example.com/handbags/*',
        ],
      });
  },

  ---

  Parameters

  • optionaloptions: EnqueueLinksOptions

    All enqueueLinks() parameters are passed via an options object.

  Returns Promise<BatchAddRequestsResult>

  Promise that resolves to BatchAddRequestsResult object.

pushData

• pushData(...args: [data: Dictionary | Dictionary[]]): Promise<void>

• This function allows you to push data to the default Dataset currently used by the crawler.

  Shortcut for crawler.pushData().

  ---

  Parameters

  • rest...args: [data: Dictionary | Dictionary[]]

  Returns Promise<void>

sendRequest

• sendRequest<Response>(overrideOptions?: Partial<OptionsInit>): Promise<Response<Response>>

• Fires HTTP request via got-scraping, allowing to override the request options on the fly.

  This is handy when you work with a browser crawler but want to execute some requests outside it (e.g. API requests). Check the Skipping navigations for certain requests example for more detailed explanation of how to do that.

  async requestHandler({ sendRequest }) {
      const { body } = await sendRequest({
          // override headers only
          headers: { ... },
      });
  },

  ---

  Type parameters

  • Response = string

  Parameters

  • optionaloverrideOptions: Partial<OptionsInit>

  Returns Promise<Response<Response>>