puppeteer/docs/api/puppeteer.page.setextrahttpheaders.md
jrandolf f07ad2c661
fix: update documentation on configuring puppeteer ()
This PR updates the docs regarding configuring puppeteer. In addition,
some changes have been made to the documentation generator to show
default values on the documentation site.

Also fixes: https://github.com/puppeteer/puppeteer/pull/9144
2022-10-24 09:07:05 +02:00

1.0 KiB
Raw Blame History

sidebar_label
Page.setExtraHTTPHeaders

Page.setExtraHTTPHeaders() method

The extra HTTP headers will be sent with every request the page initiates.

:::tip

All HTTP header names are lowercased. (HTTP headers are case-insensitive, so this shouldnt impact your server code.)

:::

:::note

page.setExtraHTTPHeaders does not guarantee the order of headers in the outgoing requests.

:::

Signature:

class Page {
  setExtraHTTPHeaders(headers: Record<string, string>): Promise<void>;
}

Parameters

Parameter Type Description
headers Record<string, string> An object containing additional HTTP headers to be sent with every request. All header values must be strings.

Returns:

Promise<void>