Skip to main content
Version: 1.17

Route

Whenever a network route is set up with page.route(url, handler[, options]) or browserContext.route(url, handler[, options]), the Route object allows to handle the route.

route.abort([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: <Promise<void>>#

Aborts the route's request.

route.continue([options])

  • options <Object>
    • headers <Object<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|Buffer> 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: <Promise<void>>#

Continues route's request with optional overrides.

await page.route('**/*', (route, request) => {
// Override headers
const headers = {
...request.headers(),
foo: 'bar', // set "foo" header
origin: undefined, // remove "origin" header
};
route.continue({headers});
});

route.fulfill([options])

  • options <Object>
    • body <string|Buffer> Response body.#
    • contentType <string> If set, equals to setting Content-Type response header.#
    • headers <Object<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.#
    • response <APIResponse> APIResponse to fulfill route's request with. Individual fields of the response (such as headers) can be overridden using fulfill options.#
    • status <number> Response status code, defaults to 200.#
  • returns: <Promise<void>>#

Fulfills route's request with given response.

An example of fulfilling all requests with 404 responses:

await page.route('**/*', route => {
route.fulfill({
status: 404,
contentType: 'text/plain',
body: 'Not Found!'
});
});

An example of serving static file:

await page.route('**/xhr_endpoint', route => route.fulfill({ path: 'mock_data.json' }));

route.request()

A request to be routed.