Skip to main content
Version: 3.4

CheerioCrawlingContext <UserData, JSONData>

Hierarchy

  • InternalHttpCrawlingContext<UserData, JSONData, CheerioCrawler>
    • CheerioCrawlingContext

Index

Properties

Methods

Properties

$

$: CheerioAPI

The Cheerio object with parsed HTML. Cheerio is available only for HTML and XML content types.

body

body: string | Buffer

The request body of the web page. The type depends on the Content-Type header of the web page:

  • String for text/html, application/xhtml+xml, application/xml MIME content types
  • Buffer for others MIME content types

contentType

contentType: { encoding: BufferEncoding; type: string }

Parsed Content-Type header: { type, encoding }.

Type declaration

  • encoding: BufferEncoding
  • type: string

crawler

crawler: CheerioCrawler

id

id: string

json

json: JSONData

The parsed object from JSON string if the response contains the content type application/json.

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.

response

response: IncomingMessage

optionalsession

session?: Session

Methods

enqueueLinks

  • 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.

parseWithCheerio

  • parseWithCheerio(): Promise<CheerioAPI>

  • Returns Cheerio handle, this is here to unify the crawler API, so they all have this handy method. It has the same return type as the $ context property, use it only if you are abstracting your workflow to support different context types in one handler.

    Example usage:

    async requestHandler({ parseWithCheerio }) {
        const $ = await parseWithCheerio();
        const title = $('title').text();
    });

    Returns Promise<CheerioAPI>

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>>

Page Options