playwright-ruby-client 1.20.2 → 1.23.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bf7d8c81cfea6013b4c2f002b93f5b705b75db9cf5ce633ed99beda7d41263f6
-  data.tar.gz: f8a705969e6aa35661b4de50ce15e94b763ddd8b7b1c454e9a323a421fa3748b
+  metadata.gz: 5d8cc3ad6fb1bd9c8a42f249085e91f92dbed26ebcbbd310559810299b60ea31
+  data.tar.gz: 6fb3450345d6f7bcbcbb19e3206244739f8aecf0813a94216e58df03674fb8e1
 SHA512:
-  metadata.gz: 8971e9467e336ea9915bc1b4ec6f1b1598e6a0a797271de5897deda8073fdc16d13d346146563c1e549de4c064a8100c853248b97de2072851727465ed6e432d
-  data.tar.gz: 4245aeee24a0004ca5d8259e01b5026bab8c32f2567c6eb2e7dfa6524d01359d3cd34d495f3bd83f95443d0776c0ea4e5cd326d857de2b886cfd6eb83084ec3f
+  metadata.gz: b4e12e990b3a9df4532154ad62d6064c343664b75d8f29d088e6c28c00b5f22608d3de49c3568af2e2ac8689e9d9769e478e36571e7921d928c21eb3a18d9a56
+  data.tar.gz: 49f939af824f3affd9bbb011eb389238d5484a3f320fed6ad170bfb8c011ac351f6dba239f4e685d6b9058f4b72461fd5d1b5aee98835e34948eeef90b535dbc

data/documentation/docs/api/api_request_context.md

@@ -5,10 +5,23 @@ sidebar_position: 10
 # APIRequestContext
 
 This API is used for the Web API testing. You can use it to trigger API endpoints, configure micro-services, prepare
-environment or the service to your e2e test. When used on [Page](./page) or a [BrowserContext](./browser_context), this API will automatically use
-the cookies from the corresponding [BrowserContext](./browser_context). This means that if you log in using this API, your e2e test will be
+environment or the service to your e2e test.
+
+Each Playwright browser context has associated with it [APIRequestContext](./api_request_context) instance which shares cookie storage with the
+browser context and can be accessed via [BrowserContext#request](./browser_context#request) or [Page#request](./page#request). It is also
+possible to create a new APIRequestContext instance manually by calling [APIRequest#new_context](./api_request#new_context).
+
+**Cookie management**
+
+[APIRequestContext](./api_request_context) retuned by [BrowserContext#request](./browser_context#request) and [Page#request](./page#request) shares cookie storage
+with the corresponding [BrowserContext](./browser_context). Each API request will have `Cookie` header populated with the values from the
+browser context. If the API response contains `Set-Cookie` header it will automatically update [BrowserContext](./browser_context) cookies
+and requests made from the page will pick them up. This means that if you log in using this API, your e2e test will be
 logged in and vice versa.
 
+If you want API requests to not interfere with the browser cookies you shoud create a new [APIRequestContext](./api_request_context) by calling
+[APIRequest#new_context](./api_request#new_context). Such [APIRequestContext](./api_request_context) object will have its own isolated cookie storage.
+
 ```ruby
 playwright.chromium.launch do |browser|
   # This will launch a new browser, create a context and page. When making HTTP

data/documentation/docs/api/browser.md

@@ -21,6 +21,14 @@ end
 
 
 
+## browser_type
+
+```
+def browser_type
+```
+
+Get the browser type (chromium, firefox or webkit) that the browser belongs to.
+
 ## close
 
 ```
@@ -93,12 +101,16 @@ def new_context(
       offline: nil,
       permissions: nil,
       proxy: nil,
+      record_har_content: nil,
+      record_har_mode: nil,
       record_har_omit_content: nil,
       record_har_path: nil,
+      record_har_url_filter: nil,
       record_video_dir: nil,
       record_video_size: nil,
       reducedMotion: nil,
       screen: nil,
+      serviceWorkers: nil,
       storageState: nil,
       strictSelectors: nil,
       timezoneId: nil,
@@ -144,12 +156,16 @@ def new_page(
       offline: nil,
       permissions: nil,
       proxy: nil,
+      record_har_content: nil,
+      record_har_mode: nil,
       record_har_omit_content: nil,
       record_har_path: nil,
+      record_har_url_filter: nil,
       record_video_dir: nil,
       record_video_size: nil,
       reducedMotion: nil,
       screen: nil,
+      serviceWorkers: nil,
       storageState: nil,
       strictSelectors: nil,
       timezoneId: nil,

data/documentation/docs/api/browser_context.md

@@ -271,9 +271,9 @@ def route(url, handler, times: nil)
 Routing provides the capability to modify network requests that are made by any page in the browser context. Once route
 is enabled, every request matching the url pattern will stall unless it's continued, fulfilled or aborted.
 
-> NOTE: [Page#route](./page#route) will not intercept requests intercepted by Service Worker. See
+> NOTE: [BrowserContext#route](./browser_context#route) will not intercept requests intercepted by Service Worker. See
 [this](https://github.com/microsoft/playwright/issues/1090) issue. We recommend disabling Service Workers when using
-request interception. Via `await context.addInitScript(() => delete window.navigator.serviceWorker);`
+request interception by setting `Browser.newContext.serviceWorkers` to `'block'`.
 
 An example of a naive handler that aborts all image requests:
 
@@ -315,6 +315,19 @@ To remove a route with its handler you can use [BrowserContext#unroute](./browse
 
 > NOTE: Enabling routing disables http cache.
 
+## route_from_har
+
+```
+def route_from_har(har, notFound: nil, update: nil, url: nil)
+```
+
+If specified the network requests that are made in the context will be served from the HAR file. Read more about
+[Replaying from HAR](https://playwright.dev/python/docs/network).
+
+Playwright will not serve requests intercepted by Service Worker from the HAR file. See
+[this](https://github.com/microsoft/playwright/issues/1090) issue. We recommend disabling Service Workers when using
+request interception by setting `Browser.newContext.serviceWorkers` to `'block'`.
+
 ## service_workers
 
 ```

data/documentation/docs/api/browser_type.md

@@ -31,7 +31,7 @@ def connect_over_cdp(
       &block)
 ```
 
-This methods attaches Playwright to an existing browser instance using the Chrome DevTools Protocol.
+This method attaches Playwright to an existing browser instance using the Chrome DevTools Protocol.
 
 The default browser context is accessible via [Browser#contexts](./browser#contexts).
 
@@ -131,12 +131,16 @@ def launch_persistent_context(
       offline: nil,
       permissions: nil,
       proxy: nil,
+      record_har_content: nil,
+      record_har_mode: nil,
       record_har_omit_content: nil,
       record_har_path: nil,
+      record_har_url_filter: nil,
       record_video_dir: nil,
       record_video_size: nil,
       reducedMotion: nil,
       screen: nil,
+      serviceWorkers: nil,
       slowMo: nil,
       strictSelectors: nil,
       timeout: nil,

data/documentation/docs/api/console_message.md

@@ -4,7 +4,33 @@ sidebar_position: 10
 
 # ConsoleMessage
 
-[ConsoleMessage](./console_message) objects are dispatched by page via the [`event: Page.console`] event.
+[ConsoleMessage](./console_message) objects are dispatched by page via the [`event: Page.console`] event. For each console messages logged
+in the page there will be corresponding event in the Playwright context.
+
+```ruby
+# Listen for all console logs
+page.on("console", ->(msg) { puts msg.text })
+
+# Listen for all console events and handle errors
+page.on("console", ->(msg) {
+  if msg.type == 'error'
+    puts "error: #{msg.text}"
+  end
+})
+
+# Get the next console log
+msg = page.expect_console_message do
+  # Issue console.log inside the page
+  page.evaluate("console.error('hello', 42, { foo: 'bar' })")
+end
+
+# Deconstruct print arguments
+msg.args[0].json_value # => 'hello'
+msg.args[1].json_value # => 42
+msg.args[2].json_value # => { 'foo' => 'bar' }
+```
+
+
 
 ## args
 

data/documentation/docs/api/element_handle.md

@@ -330,7 +330,10 @@ Returns the `element.innerText`.
 def input_value(timeout: nil)
 ```
 
-Returns `input.value` for `<input>` or `<textarea>` or `<select>` element. Throws for non-input elements.
+Returns `input.value` for the selected `<input>` or `<textarea>` or `<select>` element.
+
+Throws for non-input elements. However, if the element is inside the `<label>` element that has an associated
+[control](https://developer.mozilla.org/en-US/docs/Web/API/HTMLLabelElement/control), returns the value of the control.
 
 ## checked?
 
@@ -436,19 +439,25 @@ The method finds all elements matching the specified selector in the [ElementHan
 ```
 def screenshot(
       animations: nil,
+      caret: nil,
       mask: nil,
       omitBackground: nil,
       path: nil,
       quality: nil,
+      scale: nil,
       timeout: nil,
       type: nil)
 ```
 
-Returns the buffer with the captured screenshot.
+This method captures a screenshot of the page, clipped to the size and position of this particular element. If the
+element is covered by other elements, it will not be actually visible on the screenshot. If the element is a scrollable
+container, only the currently scrolled content will be visible on the screenshot.
 
 This method waits for the [actionability](https://playwright.dev/python/docs/actionability) checks, then scrolls element into view before taking a
 screenshot. If the element is detached from DOM, the method throws an error.
 
+Returns the buffer with the captured screenshot.
+
 ## scroll_into_view_if_needed
 
 ```
@@ -495,11 +504,6 @@ element_handle.select_option(label: "blue")
 element_handle.select_option(value: ["red", "green", "blue"])
 ```
 
-```ruby
-# multiple selection for blue, red and second option
-element_handle.select_option(value: "blue", index: 2, label: "red")
-```
-
 
 
 ## select_text
@@ -511,6 +515,10 @@ def select_text(force: nil, timeout: nil)
 This method waits for [actionability](https://playwright.dev/python/docs/actionability) checks, then focuses the element and selects all its text
 content.
 
+If the element is inside the `<label>` element that has an associated
+[control](https://developer.mozilla.org/en-US/docs/Web/API/HTMLLabelElement/control), focuses and selects text in the
+control instead.
+
 ## set_checked
 
 ```
@@ -544,11 +552,13 @@ def set_input_files(files, noWaitAfter: nil, timeout: nil)
 ```
 alias: `input_files=`
 
-This method expects `elementHandle` to point to an
-[input element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input).
-
 Sets the value of the file input to these file paths or files. If some of the `filePaths` are relative paths, then they
-are resolved relative to the the current working directory. For empty array, clears the selected files.
+are resolved relative to the current working directory. For empty array, clears the selected files.
+
+This method expects [ElementHandle](./element_handle) to point to an
+[input element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input). However, if the element is inside the
+`<label>` element that has an associated
+[control](https://developer.mozilla.org/en-US/docs/Web/API/HTMLLabelElement/control), targets the control instead.
 
 ## tap_point
 
@@ -641,8 +651,8 @@ def wait_for_element_state(state, timeout: nil)
 
 Returns when the element satisfies the `state`.
 
-Depending on the `state` parameter, this method waits for one of the [actionability](https://playwright.dev/python/docs/actionability) checks to pass.
-This method throws when the element is detached while waiting, unless waiting for the `"hidden"` state.
+Depending on the `state` parameter, this method waits for one of the [actionability](https://playwright.dev/python/docs/actionability) checks to
+pass. This method throws when the element is detached while waiting, unless waiting for the `"hidden"` state.
 - `"visible"` Wait until the element is [visible](https://playwright.dev/python/docs/actionability).
 - `"hidden"` Wait until the element is [not visible](https://playwright.dev/python/docs/actionability) or
   [not attached](https://playwright.dev/python/docs/actionability). Note that waiting for hidden does not throw when the element detaches.

data/documentation/docs/api/experimental/android.md

@@ -33,7 +33,7 @@ PLAYWRIGHT_SKIP_BROWSER_DOWNLOAD=1 npm i -D playwright
 ## devices
 
 ```
-def devices(port: nil)
+def devices(host: nil, omitDriverInstall: nil, port: nil)
 ```
 
 Returns the list of detected Android devices.

data/documentation/docs/api/experimental/android_device.md

@@ -45,12 +45,16 @@ def launch_browser(
       noViewport: nil,
       offline: nil,
       permissions: nil,
+      record_har_content: nil,
+      record_har_mode: nil,
       record_har_omit_content: nil,
       record_har_path: nil,
+      record_har_url_filter: nil,
       record_video_dir: nil,
       record_video_size: nil,
       reducedMotion: nil,
       screen: nil,
+      serviceWorkers: nil,
       strictSelectors: nil,
       timezoneId: nil,
       userAgent: nil,

data/documentation/docs/api/file_chooser.md

@@ -47,4 +47,4 @@ def set_files(files, noWaitAfter: nil, timeout: nil)
 alias: `files=`
 
 Sets the value of the file input this chooser is associated with. If some of the `filePaths` are relative paths, then
-they are resolved relative to the the current working directory. For empty array, clears the selected files.
+they are resolved relative to the current working directory. For empty array, clears the selected files.

data/documentation/docs/api/frame.md

@@ -486,7 +486,10 @@ Returns `element.innerText`.
 def input_value(selector, strict: nil, timeout: nil)
 ```
 
-Returns `input.value` for the selected `<input>` or `<textarea>` or `<select>` element. Throws for non-input elements.
+Returns `input.value` for the selected `<input>` or `<textarea>` or `<select>` element.
+
+Throws for non-input elements. However, if the element is inside the `<label>` element that has an associated
+[control](https://developer.mozilla.org/en-US/docs/Web/API/HTMLLabelElement/control), returns the value of the control.
 
 ## checked?
 
@@ -556,6 +559,8 @@ The method returns an element locator that can be used to perform actions in the
 element immediately before performing an action, so a series of actions on the same locator can in fact be performed on
 different DOM elements. That would happen if the DOM structure between those actions has changed.
 
+[Learn more about locators](https://playwright.dev/python/docs/locators).
+
 ## name
 
 ```
@@ -724,11 +729,13 @@ def set_input_files(
       timeout: nil)
 ```
 
-This method expects `selector` to point to an
-[input element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input).
-
 Sets the value of the file input to these file paths or files. If some of the `filePaths` are relative paths, then they
-are resolved relative to the the current working directory. For empty array, clears the selected files.
+are resolved relative to the current working directory. For empty array, clears the selected files.
+
+This method expects `selector` to point to an
+[input element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input). However, if the element is inside the
+`<label>` element that has an associated
+[control](https://developer.mozilla.org/en-US/docs/Web/API/HTMLLabelElement/control), targets the control instead.
 
 ## tap_point
 

data/documentation/docs/api/frame_locator.md

@@ -76,4 +76,4 @@ The method finds an element matching the specified selector in the FrameLocator'
 def nth(index)
 ```
 
-Returns locator to the n-th matching frame.
+Returns locator to the n-th matching frame. It's zero based, `nth(0)` selects the first frame.

data/documentation/docs/api/locator.md

@@ -285,6 +285,26 @@ instead.
 
 To send fine-grained keyboard events, use [Locator#type](./locator#type).
 
+## filter
+
+```
+def filter(has: nil, hasText: nil)
+```
+
+This method narrows existing locator according to the options, for example filters by text. It can be chained to filter
+multiple times.
+
+```ruby
+row_locator = page.locator("tr")
+# ...
+row_locator.
+    filter(has_text="text in column 1").
+    filter(has=page.locator("tr", has_text="column 2 button")).
+    screenshot
+```
+
+
+
 ## first
 
 ```
@@ -378,7 +398,10 @@ Returns the `element.innerText`.
 def input_value(timeout: nil)
 ```
 
-Returns `input.value` for `<input>` or `<textarea>` or `<select>` element. Throws for non-input elements.
+Returns `input.value` for the selected `<input>` or `<textarea>` or `<select>` element.
+
+Throws for non-input elements. However, if the element is inside the `<label>` element that has an associated
+[control](https://developer.mozilla.org/en-US/docs/Web/API/HTMLLabelElement/control), returns the value of the control.
 
 ## checked?
 
@@ -442,7 +465,8 @@ Returns locator to the last matching element.
 def locator(selector, has: nil, hasText: nil)
 ```
 
-The method finds an element matching the specified selector in the [Locator](./locator)'s subtree.
+The method finds an element matching the specified selector in the [Locator](./locator)'s subtree. It also accepts filter options,
+similar to [Locator#filter](./locator#filter) method.
 
 ## nth
 
@@ -450,7 +474,7 @@ The method finds an element matching the specified selector in the [Locator](./l
 def nth(index)
 ```
 
-Returns locator to the n-th matching element.
+Returns locator to the n-th matching element. It's zero based, `nth(0)` selects the first element.
 
 ## page
 
@@ -490,19 +514,25 @@ modifier, modifier is pressed and being held while the subsequent key is being p
 ```
 def screenshot(
       animations: nil,
+      caret: nil,
       mask: nil,
       omitBackground: nil,
       path: nil,
       quality: nil,
+      scale: nil,
       timeout: nil,
       type: nil)
 ```
 
-Returns the buffer with the captured screenshot.
+This method captures a screenshot of the page, clipped to the size and position of a particular element matching the
+locator. If the element is covered by other elements, it will not be actually visible on the screenshot. If the element
+is a scrollable container, only the currently scrolled content will be visible on the screenshot.
 
 This method waits for the [actionability](https://playwright.dev/python/docs/actionability) checks, then scrolls element into view before taking a
 screenshot. If the element is detached from DOM, the method throws an error.
 
+Returns the buffer with the captured screenshot.
+
 ## scroll_into_view_if_needed
 
 ```
@@ -546,11 +576,6 @@ element.select_option(label: "blue")
 element.select_option(value: ["red", "green", "blue"])
 ```
 
-```ruby
-# multiple selection for blue, red and second option
-element.select_option(value: "blue", index: 2, label: "red")
-```
-
 
 
 ## select_text
@@ -562,6 +587,10 @@ def select_text(force: nil, timeout: nil)
 This method waits for [actionability](https://playwright.dev/python/docs/actionability) checks, then focuses the element and selects all its text
 content.
 
+If the element is inside the `<label>` element that has an associated
+[control](https://developer.mozilla.org/en-US/docs/Web/API/HTMLLabelElement/control), focuses and selects text in the
+control instead.
+
 ## set_checked
 
 ```
@@ -595,11 +624,13 @@ def set_input_files(files, noWaitAfter: nil, timeout: nil)
 ```
 alias: `input_files=`
 
-This method expects `element` to point to an
-[input element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input).
-
 Sets the value of the file input to these file paths or files. If some of the `filePaths` are relative paths, then they
-are resolved relative to the the current working directory. For empty array, clears the selected files.
+are resolved relative to the current working directory. For empty array, clears the selected files.
+
+This method expects [Locator](./locator) to point to an
+[input element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input). However, if the element is inside the
+`<label>` element that has an associated
+[control](https://developer.mozilla.org/en-US/docs/Web/API/HTMLLabelElement/control), targets the control instead.
 
 ## tap_point
 

data/documentation/docs/api/page.md

@@ -642,8 +642,8 @@ Navigate to the next page in history.
 def goto(url, referer: nil, timeout: nil, waitUntil: nil)
 ```
 
-Returns the main resource response. In case of multiple redirects, the navigation will resolve with the response of the
-last redirect.
+Returns the main resource response. In case of multiple redirects, the navigation will resolve with the first
+non-redirect response.
 
 The method will throw an error if:
 - there's an SSL error (e.g. in case of self-signed certificates).
@@ -711,7 +711,10 @@ Returns `element.innerText`.
 def input_value(selector, strict: nil, timeout: nil)
 ```
 
-Returns `input.value` for the selected `<input>` or `<textarea>` or `<select>` element. Throws for non-input elements.
+Returns `input.value` for the selected `<input>` or `<textarea>` or `<select>` element.
+
+Throws for non-input elements. However, if the element is inside the `<label>` element that has an associated
+[control](https://developer.mozilla.org/en-US/docs/Web/API/HTMLLabelElement/control), returns the value of the control.
 
 ## checked?
 
@@ -781,6 +784,8 @@ The method returns an element locator that can be used to perform actions on the
 element immediately before performing an action, so a series of actions on the same locator can in fact be performed on
 different DOM elements. That would happen if the DOM structure between those actions has changed.
 
+[Learn more about locators](https://playwright.dev/python/docs/locators).
+
 Shortcut for main frame's [Frame#locator](./frame#locator).
 
 ## main_frame
@@ -970,7 +975,7 @@ Once routing is enabled, every request matching the url pattern will stall unles
 > NOTE: The handler will only be called for the first url if the response is a redirect.
 > NOTE: [Page#route](./page#route) will not intercept requests intercepted by Service Worker. See
 [this](https://github.com/microsoft/playwright/issues/1090) issue. We recommend disabling Service Workers when using
-request interception. Via `await context.addInitScript(() => delete window.navigator.serviceWorker);`
+request interception by setting `Browser.newContext.serviceWorkers` to `'block'`.
 
 An example of a naive handler that aborts all image requests:
 
@@ -1008,17 +1013,32 @@ To remove a route with its handler you can use [Page#unroute](./page#unroute).
 
 > NOTE: Enabling routing disables http cache.
 
+## route_from_har
+
+```
+def route_from_har(har, notFound: nil, update: nil, url: nil)
+```
+
+If specified the network requests that are made in the page will be served from the HAR file. Read more about
+[Replaying from HAR](https://playwright.dev/python/docs/network).
+
+Playwright will not serve requests intercepted by Service Worker from the HAR file. See
+[this](https://github.com/microsoft/playwright/issues/1090) issue. We recommend disabling Service Workers when using
+request interception by setting `Browser.newContext.serviceWorkers` to `'block'`.
+
 ## screenshot
 
 ```
 def screenshot(
       animations: nil,
+      caret: nil,
       clip: nil,
       fullPage: nil,
       mask: nil,
       omitBackground: nil,
       path: nil,
       quality: nil,
+      scale: nil,
       timeout: nil,
       type: nil)
 ```
@@ -1153,11 +1173,13 @@ def set_input_files(
       timeout: nil)
 ```
 
-This method expects `selector` to point to an
-[input element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input).
-
 Sets the value of the file input to these file paths or files. If some of the `filePaths` are relative paths, then they
-are resolved relative to the the current working directory. For empty array, clears the selected files.
+are resolved relative to the current working directory. For empty array, clears the selected files.
+
+This method expects `selector` to point to an
+[input element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input). However, if the element is inside the
+`<label>` element that has an associated
+[control](https://developer.mozilla.org/en-US/docs/Web/API/HTMLLabelElement/control), targets the control instead.
 
 ## set_viewport_size
 
@@ -1606,6 +1628,7 @@ associated with the page.
 
 ## request
 
-API testing helper associated with this page. Requests made with this API will use page cookies.
+API testing helper associated with this page. This method returns the same instance as
+[BrowserContext#request](./browser_context#request) on the page's context. See [BrowserContext#request](./browser_context#request) for more details.
 
 ## touchscreen

data/documentation/docs/api/request.md

@@ -56,7 +56,9 @@ Returns the [Frame](./frame) that initiated this request.
 def headers
 ```
 
-**DEPRECATED** Incomplete list of headers as seen by the rendering engine. Use [Request#all_headers](./request#all_headers) 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 [Request#all_headers](./request#all_headers) for complete list of
+headers that include `cookie` information.
 
 ## headers_array
 

data/documentation/docs/api/response.md

@@ -38,13 +38,24 @@ def frame
 
 Returns the [Frame](./frame) that initiated this response.
 
+## from_service_worker
+
+```
+def from_service_worker
+```
+
+Indicates whether this Response was fullfilled by a Service Worker's Fetch Handler (i.e. via
+[FetchEvent.respondWith](https://developer.mozilla.org/en-US/docs/Web/API/FetchEvent/respondWith)).
+
 ## headers
 
 ```
 def headers
 ```
 
-**DEPRECATED** Incomplete list of headers as seen by the rendering engine. Use [Response#all_headers](./response#all_headers) 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 [Response#all_headers](./response#all_headers) for complete list
+of headers that include `cookie` information.
 
 ## headers_array