Skip to main content
Version: 1.15

Route

Whenever a network route is set up with Page.RouteAsync(url, handler, options) or BrowserContext.RouteAsync(url, handler, options), the Route object allows to handle the route.

Route.AbortAsync(errorCode)#

  • errorCode <string?> Optional error code. Defaults to failed, could be one of the following:#
    • 'aborted' - An operation was aborted (due to user action)
    • 'accessdenied' - Permission to access a resource, other than the network, was denied
    • 'addressunreachable' - The IP address is unreachable. This usually means that there is no route to the specified host or network.
    • 'blockedbyclient' - The client chose to block the request.
    • 'blockedbyresponse' - The request failed because the response was delivered along with requirements which are not met ('X-Frame-Options' and 'Content-Security-Policy' ancestor checks, for instance).
    • 'connectionaborted' - A connection timed out as a result of not receiving an ACK for data sent.
    • 'connectionclosed' - A connection was closed (corresponding to a TCP FIN).
    • 'connectionfailed' - A connection attempt failed.
    • 'connectionrefused' - A connection attempt was refused.
    • 'connectionreset' - A connection was reset (corresponding to a TCP RST).
    • 'internetdisconnected' - The Internet connection has been lost.
    • 'namenotresolved' - The host name could not be resolved.
    • 'timedout' - An operation timed out.
    • 'failed' - A generic failure occurred.
  • returns: <void>#

Aborts the route's request.

Route.ContinueAsync(options)#

  • options <RouteContinueOptions?>
    • Headers <IDictionary?<string, string>> If set changes the request HTTP headers. Header values will be converted to a string.#
    • Method <string?> If set changes the request method (e.g. GET or POST)#
    • PostData <string?|byte[]?> If set changes the post data of request#
    • Url <string?> If set changes the request URL. New URL must have same protocol as original one.#
  • returns: <void>#

Continues route's request with optional overrides.

await page.RouteAsync("**/*", route =>{    var headers = new Dictionary<string, string>(route.Request.Headers) { { "foo", "bar" } };    headers.Remove("origin");    route.ContinueAsync(headers);});

Route.FulfillAsync(options)#

  • options <RouteFulfillOptions?>
    • Body <string?> Optional response body as text.#
    • BodyBytes <byte[]?> Optional response body as raw bytes.#
    • ContentType <string?> If set, equals to setting Content-Type response header.#
    • Headers <IDictionary?<string, string>> Response headers. Header values will be converted to a string.#
    • Path <string?> File path to respond with. The content type will be inferred from file extension. If path is a relative path, then it is resolved relative to the current working directory.#
    • Status <int?> Response status code, defaults to 200.#
  • returns: <void>#

Fulfills route's request with given response.

An example of fulfilling all requests with 404 responses:

await page.RouteAsync("**/*", route => route.FulfillAsync(    status: 404,    contentType: "text/plain",     body: "Not Found!"));

An example of serving static file:

await page.RouteAsync("**/xhr_endpoint", route => route.FulfillAsync(new RouteFulfillOptions { Path = "mock_data.json" }));

Route.Request#

A request to be routed.