PuppeteerCrawlingContext <UserData>

Hierarchy

• BrowserCrawlingContext<Page, HTTPResponse, PuppeteerController, UserData>
• PuppeteerContextUtils
  • PuppeteerCrawlingContext

Index

Properties

• browserController
• crawler
• enqueueLinks
• id
• log
• page
• proxyInfo
• request
• response
• sendRequest
• session

Methods

• addInterceptRequestHandler
• blockRequests
• blockResources
• cacheResponses
• compileScript
• enqueueLinksByClickingElements
• infiniteScroll
• injectFile
• injectJQuery
• parseWithCheerio
• removeInterceptRequestHandler
• saveSnapshot

Properties

browserController

browserController: PuppeteerController

Inherited from BrowserCrawlingContext.browserController

crawler

crawler: BrowserCrawler<BrowserPoolOptions<BrowserPlugin<CommonLibrary, unknown, CommonBrowser, unknown, CommonPage>>, Dictionary<any>, BrowserCrawlingContext<CommonPage, Dictionary<any>, BrowserController<CommonLibrary, unknown, CommonBrowser, unknown, CommonPage>, Dictionary<any>>, Dictionary<any>>

Inherited from BrowserCrawlingContext.crawler

enqueueLinks

enqueueLinks: (options?: BrowserCrawlerEnqueueLinksOptions) => Promise<BatchAddRequestsResult>

Inherited from BrowserCrawlingContext.enqueueLinks

Type declaration

• • (options?: BrowserCrawlerEnqueueLinksOptions): Promise<BatchAddRequestsResult>

  • Parameters

    • optionaloptions: BrowserCrawlerEnqueueLinksOptions

    Returns Promise<BatchAddRequestsResult>

id

id: string

Inherited from BrowserCrawlingContext.id

log

log: Log

Inherited from BrowserCrawlingContext.log

page

page: Page

Inherited from BrowserCrawlingContext.page

optionalproxyInfo

proxyInfo?: ProxyInfo

Inherited from BrowserCrawlingContext.proxyInfo

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

request

request: Request<UserData>

Inherited from BrowserCrawlingContext.request

The original Request object.

optionalresponse

response?: HTTPResponse

Inherited from BrowserCrawlingContext.response

sendRequest

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

Inherited from BrowserCrawlingContext.sendRequest

Type declaration

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

  • Parameters

    • optionaloverrideOptions: Partial<OptionsInit>

    Returns Promise<Response<string>>

optionalsession

session?: Session

Inherited from BrowserCrawlingContext.session

Methods

addInterceptRequestHandler

• addInterceptRequestHandler(handler: InterceptHandler): Promise<void>

• Inherited from PuppeteerContextUtils.addInterceptRequestHandler

  Parameters

  • handler: InterceptHandler

  Returns Promise<void>

blockRequests

• blockRequests(options?: BlockRequestsOptions): Promise<void>

• Inherited from PuppeteerContextUtils.blockRequests

  Parameters

  • optionaloptions: BlockRequestsOptions

  Returns Promise<void>

blockResources

• blockResources(resourceTypes?: string[]): Promise<void>

• Inherited from PuppeteerContextUtils.blockResources

  Parameters

  • optionalresourceTypes: string[]

  Returns Promise<void>

cacheResponses

• cacheResponses(cache: Dictionary<Partial<ResponseForRequest>>, responseUrlRules: (string | RegExp)[]): Promise<void>

• Inherited from PuppeteerContextUtils.cacheResponses

  Parameters

  • cache: Dictionary<Partial<ResponseForRequest>>

  • responseUrlRules: (string | RegExp)[]

  Returns Promise<void>

compileScript

• compileScript(scriptString: string, ctx?: Dictionary<any>): CompiledScriptFunction

• Inherited from PuppeteerContextUtils.compileScript

  Parameters

  • scriptString: string

  • optionalctx: Dictionary<any>

  Returns CompiledScriptFunction

enqueueLinksByClickingElements

• enqueueLinksByClickingElements(options: Omit<EnqueueLinksByClickingElementsOptions, requestQueue | page>): Promise<BatchAddRequestsResult>

• Inherited from PuppeteerContextUtils.enqueueLinksByClickingElements

  Parameters

  • options: Omit<EnqueueLinksByClickingElementsOptions, requestQueue | page>

  Returns Promise<BatchAddRequestsResult>

infiniteScroll

• infiniteScroll(options?: InfiniteScrollOptions): Promise<void>

• Inherited from PuppeteerContextUtils.infiniteScroll

  Parameters

  • optionaloptions: InfiniteScrollOptions

  Returns Promise<void>

injectFile

• injectFile(filePath: string, options?: InjectFileOptions): Promise<unknown>

• Inherited from PuppeteerContextUtils.injectFile

  Parameters

  • filePath: string

  • optionaloptions: InjectFileOptions

  Returns Promise<unknown>

injectJQuery

• injectJQuery(): Promise<unknown>

• Inherited from PuppeteerContextUtils.injectJQuery

  Returns Promise<unknown>

parseWithCheerio

• parseWithCheerio(): Promise<CheerioAPI>

• Inherited from PuppeteerContextUtils.parseWithCheerio

  Returns Promise<CheerioAPI>

removeInterceptRequestHandler

• removeInterceptRequestHandler(handler: InterceptHandler): Promise<void>

• Inherited from PuppeteerContextUtils.removeInterceptRequestHandler

  Parameters

  • handler: InterceptHandler

  Returns Promise<void>

saveSnapshot

• saveSnapshot(options?: SaveSnapshotOptions): Promise<void>

• Inherited from PuppeteerContextUtils.saveSnapshot

  Parameters

  • optionaloptions: SaveSnapshotOptions

  Returns Promise<void>