Skip to content

Commit

Permalink
cherry-pick(#15152): chore: undeprecate sync headers()
Browse files Browse the repository at this point in the history
  • Loading branch information
pavelfeldman committed Jun 27, 2022
1 parent 29ec22b commit 5c6335e
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 8 deletions.
4 changes: 3 additions & 1 deletion docs/src/api/class-request.md
Expand Up @@ -59,7 +59,9 @@ Returns the [Frame] that initiated this request.
## method: Request.headers
- returns: <[Object]<[string], [string]>>

**DEPRECATED** Incomplete list of headers as seen by the rendering engine. Use [`method: Request.allHeaders`] instead.
An object with the request HTTP headers. The header names are lower-cased.
Note that this method does not return security-related headers, including cookie-related ones.
You can use [`method: Request.allHeaders`] for complete list of headers that include `cookie` information.

## async method: Request.headersArray
- returns: <[Array]<[Object]>>
Expand Down
4 changes: 3 additions & 1 deletion docs/src/api/class-response.md
Expand Up @@ -30,7 +30,9 @@ Indicates whether this Response was fullfilled by a Service Worker's Fetch Handl
## method: Response.headers
- returns: <[Object]<[string], [string]>>

**DEPRECATED** Incomplete list of headers as seen by the rendering engine. Use [`method: Response.allHeaders`] instead.
An object with the response HTTP headers. The header names are lower-cased.
Note that this method does not return security-related headers, including cookie-related ones.
You can use [`method: Response.allHeaders`] for complete list of headers that include `cookie` information.

## async method: Response.headersArray
- returns: <[Array]<[Object]>>
Expand Down
14 changes: 8 additions & 6 deletions packages/playwright-core/types/types.d.ts
Expand Up @@ -14858,9 +14858,10 @@ export interface Request {
frame(): Frame;

/**
* **DEPRECATED** Incomplete list of headers as seen by the rendering engine. Use
* [request.allHeaders()](https://playwright.dev/docs/api/class-request#request-all-headers) instead.
* @deprecated
* An object with the request HTTP headers. The header names are lower-cased. Note that this method does not return
* security-related headers, including cookie-related ones. You can use
* [request.allHeaders()](https://playwright.dev/docs/api/class-request#request-all-headers) for complete list of headers
* that include `cookie` information.
*/
headers(): { [key: string]: string; };

Expand Down Expand Up @@ -15095,9 +15096,10 @@ export interface Response {
fromServiceWorker(): boolean;

/**
* **DEPRECATED** Incomplete list of headers as seen by the rendering engine. Use
* [response.allHeaders()](https://playwright.dev/docs/api/class-response#response-all-headers) instead.
* @deprecated
* An object with the response HTTP headers. The header names are lower-cased. Note that this method does not return
* security-related headers, including cookie-related ones. You can use
* [response.allHeaders()](https://playwright.dev/docs/api/class-response#response-all-headers) for complete list of
* headers that include `cookie` information.
*/
headers(): { [key: string]: string; };

Expand Down

0 comments on commit 5c6335e

Please sign in to comment.