puppeteer/docs/api/puppeteer.page.setextrahttpheaders.md
jrandolf f07ad2c661
fix: update documentation on configuring puppeteer (#9150)
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

38 lines
1.0 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

---
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:
```typescript
class Page {
setExtraHTTPHeaders(headers: Record<string, string>): Promise<void>;
}
```
## Parameters
| Parameter | Type | Description |
| --------- | ---------------------------- | -------------------------------------------------------------------------------------------------------------- |
| headers | Record&lt;string, string&gt; | An object containing additional HTTP headers to be sent with every request. All header values must be strings. |
**Returns:**
Promise&lt;void&gt;