docs: add return subheadings

mdcruz · mdcruz · commit 95398b184f9a · 2023-05-15T20:03:38.000+01:00
diff --git a/src/data/markdown/docs/02 javascript api/07 k6-experimental/01 browser/10 Page.md b/src/data/markdown/docs/02 javascript api/07 k6-experimental/01 browser/10 Page.md
@@ -19,8 +19,8 @@ Page provides methods to interact with a single tab in a running web browser. A
 | [page.$$(selector)](/javascript-api/k6-experimental/browser/page/page-$$/)       | Finds all elements matching the specified `selector` within the page. |
 | [page.emulateMedia([options])](/javascript-api/k6-experimental/browser/page/emulatemedia/)                             | Changes the CSS media type and the color scheme feature.                                                                   |
 | [page.emulateVisionDeficiency(type)](/javascript-api/k6-experimental/browser/page/emulatevisiondeficiency/)       | Emulates your website with the specified vision deficiency `type`.                                                           |
-| [page.evaluate(pageFunction[, arg])](/javascript-api/k6-experimental/browser/page/evaluate/)       | Returns the value of the pageFunction invocation.                                                          |
-| [page.evaluateHandle(pageFunction[, arg])](/javascript-api/k6-experimental/browser/page/evaluate/)       | Returns the value of the pageFunction invocation as a [JSHandle](javascript-api/k6-experimental/browser/jshandle/).                                                        |
+| [page.evaluate(pageFunction[, arg])](/javascript-api/k6-experimental/browser/page/evaluate/)       | Returns the value of the `pageFunction` invocation.                                                          |
+| [page.evaluateHandle(pageFunction[, arg])](/javascript-api/k6-experimental/browser/page/evaluate/)       | Returns the value of the `pageFunction` invocation as a [JSHandle](javascript-api/k6-experimental/browser/jshandle/).                                                        |
 | [page.fill(selector, value[, options])](/javascript-api/k6-experimental/browser/page/fill/)       | Fill an `input`, `textarea` or `contenteditable` element with the provided value.                                                      |
 | [page.focus(selector[, options])](/javascript-api/k6-experimental/browser/page/focus/)       | Fetches an element with `selector` and focuses on it.                                                  |
 | [page.frames()](/javascript-api/k6-experimental/browser/page/frames/)       | Returns an array of frames on the page.                                                  |
@@ -31,7 +31,7 @@ Page provides methods to interact with a single tab in a running web browser. A
 | [page.innerText(selector[, options])](/javascript-api/k6-experimental/browser/page/innertext/)       | Returns the `element.innerText`.                                                |
 | [page.inputValue(selector[, options])](/javascript-api/k6-experimental/browser/page/inputvalue/)       | Returns `input.value` for the selected `input`, `textarea` or `select` element.                                               |
 | [page.isChecked(selector[, options])](/javascript-api/k6-experimental/browser/page/ischecked/)       | Checks to see if the `checkbox` `input` type is selected or not.                                               |
-| [page.isClosed()](/javascript-api/k6-experimental/browser/page/isclosed/)       | Checks if the page has been closed.                                           |
+| [page.isClosed()](/javascript-api/k6-experimental/browser/page/isclosed/) <BWIPT id="878"/>       | Checks if the page has been closed.                                           |
 | [page.isDisabled(selector[, options])](/javascript-api/k6-experimental/browser/page/isdisabled/)       | Checks if the element is `disabled`.                                        |
 | [page.isEditable(selector[, options])](/javascript-api/k6-experimental/browser/page/iseditable/)       | Checks if the element is `editable`.                                      |
 | [page.isEnabled(selector[, options])](/javascript-api/k6-experimental/browser/page/isenabbled/)       | Checks if the element is `enabled`.                                      |
@@ -60,7 +60,7 @@ Page provides methods to interact with a single tab in a running web browser. A
 | [page.url()](/javascript-api/k6-experimental/browser/page/url/)       | Returns the `page`'s URL.         |
 | [page.viewportSize()](/javascript-api/k6-experimental/browser/page/viewportsize/)       | Returns the `page`'s size (width and height).         |
 | [page.waitForFunction(pageFunction, arg[, options])](/javascript-api/k6-experimental/browser/page/waitforfunction/)       | Returns when the `pageFunction` returns a truthy value.         |
-| [page.waitForLoadState(state[, options])](/javascript-api/k6-experimental/browser/page/waitforloadstate/)       | Waits for the given load `state` to be reached.         |
+| [page.waitForLoadState(state[, options])](/javascript-api/k6-experimental/browser/page/waitforloadstate/) <BWIPT id="880"/>       | Waits for the given load `state` to be reached.         |
 | [page.waitForNavigation([options])](/javascript-api/k6-experimental/browser/page/waitfornavigation/)       | Waits for the given navigation lifecycle event to occur and returns the main resource response.         |
 | [page.waitForSelector(selector[, options])](/javascript-api/k6-experimental/browser/page/waitforselector/)       | Returns when element specified by selector satisfies `state` option.        |
 | [page.waitForTimeout(timeout)](/javascript-api/k6-experimental/browser/page/waitfortimeout/)       | Waits for the given `timeout` in milliseconds. |
diff --git a/src/data/markdown/docs/02 javascript api/07 k6-experimental/01 browser/10 Page/click--options--.md b/src/data/markdown/docs/02 javascript api/07 k6-experimental/01 browser/10 Page/click--options--.md
@@ -32,6 +32,12 @@ This method clicks on an element matching a `selector`.
 
 </TableWithNestedRows>
 
+### Returns
+
+| Type                 | Description                                                                                     |
+| ----                 | -----------                                                                                     |
+| Promise              | An asynchronous operation that doesn't return a value.                                          |
+
 ### Example
 
 <CodeGroup labels={["Click action without navigation"]}>
diff --git a/src/data/markdown/docs/02 javascript api/07 k6-experimental/01 browser/10 Page/content.md b/src/data/markdown/docs/02 javascript api/07 k6-experimental/01 browser/10 Page/content.md
@@ -5,6 +5,12 @@ excerpt: 'Browser module: page.content method'
 
 Gets the HTML contents of the page.
 
+### Returns
+
+| Type                 | Description                                                                                     |
+| ----                 | -----------                                                                                     |
+| string               | The HTML contents of the page.                                                                  |
+
 ### Example
 
 <CodeGroup labels={[]}>
diff --git a/src/data/markdown/docs/02 javascript api/07 k6-experimental/01 browser/10 Page/context.md b/src/data/markdown/docs/02 javascript api/07 k6-experimental/01 browser/10 Page/context.md
@@ -5,6 +5,12 @@ excerpt: 'Browser module: page.context method'
 
 Gets the [BrowserContext](/javascript-api/k6-experimental/browser/browsercontext/) that the page belongs to.
 
+### Returns
+
+| Type                 | Description                                                                                     |
+| ----                 | -----------                                                                                     |
+| [BrowserContext](/javascript-api/k6-experimental/browser/browsercontext/)               | The `BrowserContext` that the page belongs to.          |
+
 ### Example
 
 <CodeGroup labels={[]}>
diff --git a/src/data/markdown/docs/02 javascript api/07 k6-experimental/01 browser/10 Page/dollar--options--.md b/src/data/markdown/docs/02 javascript api/07 k6-experimental/01 browser/10 Page/dollar--options--.md
@@ -11,6 +11,12 @@ Use locator-based [`page.locator(selector)`](/javascript-api/k6-experimental/bro
 
 The method finds an element matching the specified selector within the page. If no elements match the selector, the return value resolves to `null`. To wait for an element on the page, use [locator.waitFor([options])](/javascript-api/k6-experimental/browser/locator/waitfor/).
 
+### Returns
+
+| Type                 | Description                                                                                     |
+| ----                 | -----------                                                                                     |
+| null or [ElementHandle](javascript-api/k6-experimental/browser/keyboard/)              | Returns `ElementHandle` when a matching element is found. Else, it returns `null`.        |
+
 ### Example
 
 <CodeGroup labels={[]}>
diff --git a/src/data/markdown/docs/02 javascript api/07 k6-experimental/01 browser/10 Page/doubledollar--options--.md b/src/data/markdown/docs/02 javascript api/07 k6-experimental/01 browser/10 Page/doubledollar--options--.md
@@ -11,6 +11,12 @@ Use locator-based [`page.locator(selector)`](/javascript-api/k6-experimental/bro
 
 The method finds all elements matching the specified selector within the page. If no elements match the selector, the return value resolves to `[]`.
 
+### Returns
+
+| Type                 | Description                                                                                     |
+| ----                 | -----------                                                                                     |
+| null or [ElementHandle](javascript-api/k6-experimental/browser/keyboard/)[]              | Returns an array of `ElementHandle` when multiple elements are found. Else, it returns `null`.        |
+
 ### Example
 
 <CodeGroup labels={[]}>
diff --git a/src/data/markdown/docs/02 javascript api/07 k6-experimental/01 browser/10 Page/evaluate.md b/src/data/markdown/docs/02 javascript api/07 k6-experimental/01 browser/10 Page/evaluate.md
@@ -14,6 +14,12 @@ Returns the value of the `pageFunction` invocation.
 
 </TableWithNestedRows>
 
+### Returns
+
+| Type                 | Description                                                                                     |
+| ----                 | -----------                                                                                     |
+| any              | The value of the `pageFunction` invocation.         |
+
 ### Example
 
 <CodeGroup labels={[]}>
diff --git a/src/data/markdown/docs/02 javascript api/07 k6-experimental/01 browser/10 Page/evaluateHandle.md b/src/data/markdown/docs/02 javascript api/07 k6-experimental/01 browser/10 Page/evaluateHandle.md
@@ -16,6 +16,13 @@ The only difference between `page.evaluate()` and `page.evaluateHandle()` is tha
 
 </TableWithNestedRows>
 
+### Returns
+
+| Type                 | Description                                                                                     |
+| ----                 | -----------                                                                                     |
+| [JSHandle](/javascript-api/k6-experimental/browser/jshandle/)               | The `JSHandle` instance associated with the page.                                                                |
+
+
 ### Example
 
 <CodeGroup labels={[]}>
diff --git a/src/data/markdown/docs/02 javascript api/07 k6-experimental/01 browser/10 Page/frames.md b/src/data/markdown/docs/02 javascript api/07 k6-experimental/01 browser/10 Page/frames.md
@@ -3,7 +3,13 @@ title: 'frames()'
 excerpt: 'Browser module: page.frames method'
 ---
 
-Returns an array of frames on the page.
+Returns an array of [Frames](/javascript-api/k6-experimental/browser/frame/) on the page.
+
+### Returns
+
+| Type                 | Description                                                                                     |
+| ----                 | -----------                                                                                     |
+| [Frames](/javascript-api/k6-experimental/browser/frame/)[]               | An array of `Frames` associated with the page.        |
 
 ### Example
 
diff --git a/src/data/markdown/docs/02 javascript api/07 k6-experimental/01 browser/10 Page/getattribute--options--.md b/src/data/markdown/docs/02 javascript api/07 k6-experimental/01 browser/10 Page/getattribute--options--.md
@@ -27,7 +27,7 @@ Returns the element attribute value for the given attribute name.
 
 | Type   | Description                         |
 |--------|-------------------------------------|
-| string | The value of the attribute or null. |
+| null or string | The value of the attribute. Else, it returns `null`. |
 
 ### Example
 
diff --git a/src/data/markdown/docs/02 javascript api/07 k6-experimental/01 browser/10 Page/goto--options--.md b/src/data/markdown/docs/02 javascript api/07 k6-experimental/01 browser/10 Page/goto--options--.md
@@ -33,6 +33,12 @@ Events can be either:
 - `'load'` - consider operation to be finished when the `load` event is fired.
 - `'networkidle'` - Consider operation to be finished when there are no network connections for at least `500` ms. 
 
+### Returns
+
+| Type                 | Description                                                                                     |
+| ----                 | -----------                                                                                     |
+| Promise<null or [Response](/javascript-api/k6-experimental/browser/response/)>               | The `Response` instance associated with the page. Else, it returns `null`. |
+
 ### Example
 
 <CodeGroup labels={[]}>
diff --git a/src/data/markdown/docs/02 javascript api/07 k6-experimental/01 browser/10 Page/isclosed--options--.md b/src/data/markdown/docs/02 javascript api/07 k6-experimental/01 browser/10 Page/isclosed--options--.md
@@ -11,6 +11,12 @@ This method has **known issues**. For details, refer to [#878](https://github.co
 
 Checks if the page has been closed.
 
+### Returns
+
+| Type | Description                                       |
+|------|---------------------------------------------------|
+| bool | `true` if the page has been closed, else `false`. |
+
 ### Example
 
 <CodeGroup labels={[]}>
diff --git a/src/data/markdown/docs/02 javascript api/07 k6-experimental/01 browser/10 Page/keyboard.md b/src/data/markdown/docs/02 javascript api/07 k6-experimental/01 browser/10 Page/keyboard.md
@@ -5,6 +5,12 @@ excerpt: 'Browser module: page.keyboard method'
 
 Returns the [Keyboard](javascript-api/k6-experimental/browser/keyboard/) instance to interact with a virtual keyboard on the page.
 
+### Returns
+
+| Type                 | Description                                                                                     |
+| ----                 | -----------                                                                                     |
+| [Keyboard](/javascript-api/k6-experimental/browser/keyboard/)              | The `Keyboard` instance associated with the page.          |
+
 ### Example
 
 <CodeGroup labels={[]}>
diff --git a/src/data/markdown/docs/02 javascript api/07 k6-experimental/01 browser/10 Page/locator.md b/src/data/markdown/docs/02 javascript api/07 k6-experimental/01 browser/10 Page/locator.md
@@ -10,6 +10,11 @@ The method returns an element [Locator](/javascript-api/k6-experimental/browser/
 |-----------------|--------|---------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
 | selector        | string  | `''`    |  A selector to use when resolving DOM element.                                                                                                               |
 
+### Returns
+
+| Type                 | Description                                                                                     |
+| ----                 | -----------                                                                                     |
+| [Locator](/javascript-api/k6-experimental/browser/locator/)               | The element `Locator` associated with the page.        |
 
 ### Example
 
diff --git a/src/data/markdown/docs/02 javascript api/07 k6-experimental/01 browser/10 Page/mouse.md b/src/data/markdown/docs/02 javascript api/07 k6-experimental/01 browser/10 Page/mouse.md
@@ -5,6 +5,12 @@ excerpt: 'Browser module: page.mouse method'
 
 Returns the [Mouse](javascript-api/k6-experimental/browser/mouse/) instance to interact with a virtual mouse on the page.
 
+### Returns
+
+| Type                 | Description                                                                                     |
+| ----                 | -----------                                                                                     |
+| [Mouse](/javascript-api/k6-experimental/browser/mouse/)              | The `Mouse` instance associated with the page.          |
+
 ### Example
 
 <CodeGroup labels={[]}>
diff --git a/src/data/markdown/docs/02 javascript api/07 k6-experimental/01 browser/10 Page/opener.md b/src/data/markdown/docs/02 javascript api/07 k6-experimental/01 browser/10 Page/opener.md
@@ -5,6 +5,12 @@ excerpt: 'Browser module: page.mouse method'
 
 Returns the page that opened the current page. The first page that is navigated to will have a `null` opener.
 
+### Returns
+
+| Type                 | Description                                                                                     |
+| ----                 | -----------                                                                                     |
+| null or [Page](/javascript-api/k6-experimental/browser/page/)              | The `Page` instance. Else, it returns `null`.        |
+
 ### Example
 
 <CodeGroup labels={[]}>
diff --git a/src/data/markdown/docs/02 javascript api/07 k6-experimental/01 browser/10 Page/reload--options--.md b/src/data/markdown/docs/02 javascript api/07 k6-experimental/01 browser/10 Page/reload--options--.md
@@ -29,6 +29,12 @@ Events can be either:
 - `'load'` - consider operation to be finished when the `load` event is fired.
 - `'networkidle'` - Consider operation to be finished when there are no network connections for at least `500` ms. 
 
+### Returns
+
+| Type                 | Description                                                                                     |
+| ----                 | -----------                                                                                     |
+| null or [Response](/javascript-api/k6-experimental/browser/response/)              | The `Response` instance associated with the page. Else, it returns `null`.         |
+
 ### Example
 
 <CodeGroup labels={[]}>
diff --git a/src/data/markdown/docs/02 javascript api/07 k6-experimental/01 browser/10 Page/screenshot--options--.md b/src/data/markdown/docs/02 javascript api/07 k6-experimental/01 browser/10 Page/screenshot--options--.md
@@ -23,6 +23,12 @@ Returns the buffer with the captured screenshot from the browser.
 
 </TableWithNestedRows>
 
+### Returns
+
+| Type                 | Description                                                                                     |
+| ----                 | -----------                                                                                     |
+| [Buffer](https://nodejs.org/api/buffer.html#buffer_class_buffer)              | The buffer with the captured screenshot.         |
+
 ### Example
 
 <CodeGroup labels={[]}>
diff --git a/src/data/markdown/docs/02 javascript api/07 k6-experimental/01 browser/10 Page/title.md b/src/data/markdown/docs/02 javascript api/07 k6-experimental/01 browser/10 Page/title.md
@@ -5,6 +5,12 @@ excerpt: 'Browser module: page.title method'
 
 Returns the page's title.
 
+### Returns
+
+| Type | Description                                       |
+|------|---------------------------------------------------|
+| string | The page's title. |
+
 ### Example
 
 <CodeGroup labels={[]}>
diff --git a/src/data/markdown/docs/02 javascript api/07 k6-experimental/01 browser/10 Page/touchscreen.md b/src/data/markdown/docs/02 javascript api/07 k6-experimental/01 browser/10 Page/touchscreen.md
@@ -5,6 +5,12 @@ excerpt: 'Browser module: page.touchScreen method'
 
 Returns the [Touchscreen](/javascript-api/k6-experimental/browser/touchscreen/) instance to interact with a virtual touchscreen on the page.
 
+### Returns
+
+| Type                 | Description                                                                                     |
+| ----                 | -----------                                                                                     |
+| [Touchscreen](/javascript-api/k6-experimental/browser/touchscreen/)              | The `Touchscreen` instance associated with the page.          |
+
 ### Example
 
 <CodeGroup labels={[]}>
diff --git a/src/data/markdown/docs/02 javascript api/07 k6-experimental/01 browser/10 Page/url.md b/src/data/markdown/docs/02 javascript api/07 k6-experimental/01 browser/10 Page/url.md
@@ -5,6 +5,12 @@ excerpt: 'Browser module: page.url method'
 
 Returns the page's URL.
 
+### Returns
+
+| Type                 | Description                                                                                     |
+| ----                 | -----------                                                                                     |
+| string               | The page's URL.                                              |
+
 ### Example
 
 <CodeGroup labels={[]}>
diff --git a/src/data/markdown/docs/02 javascript api/07 k6-experimental/01 browser/10 Page/viewportsize.md b/src/data/markdown/docs/02 javascript api/07 k6-experimental/01 browser/10 Page/viewportsize.md
@@ -5,6 +5,12 @@ excerpt: 'Browser module: page.viewportSize method'
 
 Returns the page's size (width and height).
 
+### Returns
+
+| Type                 | Description                                                                                     |
+| ----                 | -----------                                                                                     |
+| Object               | An object containing the page's width and height.                                               |
+
 ### Example
 
 <CodeGroup labels={[]}>
diff --git a/src/data/markdown/docs/02 javascript api/07 k6-experimental/01 browser/10 Page/waitforfunction--options--.md b/src/data/markdown/docs/02 javascript api/07 k6-experimental/01 browser/10 Page/waitforfunction--options--.md
@@ -17,6 +17,12 @@ Returns when the `pageFunction` returns a truthy value.
 
 </TableWithNestedRows>
 
+### Returns
+
+| Type                 | Description                                                                                     |
+| ----                 | -----------                                                                                     |
+| Promise<[JSHandle](/javascript-api/k6-experimental/browser/jshandle/)>               | The `JSHandle` instance associated with the page. |
+
 ### Example
 
 <CodeGroup labels={[]}>
diff --git a/src/data/markdown/docs/02 javascript api/07 k6-experimental/01 browser/10 Page/waitfornavigation--options--.md b/src/data/markdown/docs/02 javascript api/07 k6-experimental/01 browser/10 Page/waitfornavigation--options--.md
@@ -30,6 +30,12 @@ Events can be either:
 - `'load'` - consider operation to be finished when the `load` event is fired.
 - `'networkidle'` - Consider operation to be finished when there are no network connections for at least `500` ms. 
 
+### Returns
+
+| Type                 | Description                                                                                     |
+| ----                 | -----------                                                                                     |
+| Promise<null or [Response](/javascript-api/k6-experimental/browser/response/)>               | The `Response` instance associated with the page. Else, it returns `null` |
+
 ### Example
 
 <CodeGroup labels={[]}>
diff --git a/src/data/markdown/docs/02 javascript api/07 k6-experimental/01 browser/10 Page/waitforselector--options--.md b/src/data/markdown/docs/02 javascript api/07 k6-experimental/01 browser/10 Page/waitforselector--options--.md
@@ -32,6 +32,12 @@ Element states can be either:
 - `'visible'` - wait for element to have non-empty bounding box and no `visibility:hidden`.
 - `'hidden'` - wait for element to be either detached from DOM, or have an empty bounding box or `visibility:hidden`.
 
+### Returns
+
+| Type                 | Description                                                                                     |
+| ----                 | -----------                                                                                     |
+| null or [ElementHandle](/javascript-api/k6-experimental/browser/keyboard/)              | `ElementHandle` when a matching element is found. Else, it returns `null`.        |
+
 ### Example
 
 <CodeGroup labels={[]}>
diff --git a/src/data/markdown/docs/02 javascript api/07 k6-experimental/01 browser/10 Page/workers.md b/src/data/markdown/docs/02 javascript api/07 k6-experimental/01 browser/10 Page/workers.md
