Skip to main content
Version: 3.5

PlaywrightHook

Hierarchy

Callable

  • PlaywrightHook(crawlingContext: PlaywrightCrawlingContext<Dictionary>, gotoOptions: undefined | { referer?: string; timeout?: number; waitUntil?: domcontentloaded | load | networkidle | commit }): Awaitable<void>

  • Parameters

    • crawlingContext: PlaywrightCrawlingContext<Dictionary>
    • gotoOptions: undefined | { referer?: string; timeout?: number; waitUntil?: domcontentloaded | load | networkidle | commit }
      • externaloptionalreferer: string

        Referer header value. If provided it will take preference over the referer header value set by page.setExtraHTTPHeaders(headers).

      • externaloptionaltimeout: number

        Maximum operation time in milliseconds. Defaults to 0 - no timeout. The default value can be changed via navigationTimeout option in the config, or by using the browserContext.setDefaultNavigationTimeout(timeout), browserContext.setDefaultTimeout(timeout), page.setDefaultNavigationTimeout(timeout) or page.setDefaultTimeout(timeout) methods.

      • externaloptionalwaitUntil: domcontentloaded | load | networkidle | commit

        When to consider operation succeeded, defaults to load. Events can be either:

        • 'domcontentloaded' - consider operation to be finished when the DOMContentLoaded event is fired.
        • 'load' - consider operation to be finished when the load event is fired.
        • 'networkidle' - DISCOURAGED consider operation to be finished when there are no network connections for at least 500 ms. Don't use this method for testing, rely on web assertions to assess readiness instead.
        • 'commit' - consider operation to be finished when network response is received and the document started loading.

    Returns Awaitable<void>