Document Element.selection - grafana/k6#3519

grafana · Jan 16, 2024 · d175b88 · d175b88
1 parent 44a5554
commit d175b88
Show file tree

Hide file tree

Showing 2 changed files with 35 additions and 0 deletions.
diff --git a/docs/sources/next/javascript-api/k6-html/element/_index.md b/docs/sources/next/javascript-api/k6-html/element/_index.md
@@ -16,6 +16,7 @@ The Element object provides a similar API to the [DOM Element API](https://devel
 
 | Method                 | Description                                                                                                                                                              |
 | ---------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| [selection](https://grafana.com/docs/k6/<K6_VERSION>/javascript-api/k6-html/element/element-selection) | returns the selection that is matching the element                                                                                                                       |
 | nodeName               | The name of the element.                                                                                                                                                 |
 | nodeType               | The type of the element.                                                                                                                                                 |
 | nodeValue              | The element value.                                                                                                                                                       |

diff --git a/docs/sources/next/javascript-api/k6-html/element/element-selection.md b/docs/sources/next/javascript-api/k6-html/element/element-selection.md
@@ -0,0 +1,34 @@
+---
+title: 'Element.selectionet()'
+excerpt: 'Retrieve the Selection matching this element.'
+---
+
+# Element.selection()
+
+Retrieve the Selection matching this element.
+
+Mimics `$(element)`
+
+### Returns
+
+| Type    | Description                          |
+| ------- | ------------------------------------ |
+| Selection | The Selection mathing this element. |
+
+### Example
+
+{{< code >}}
+
+```javascript
+import http from "k6/http";
+
+export default () => {
+	let li = http.get("https://test.k6.io").html().find("li");
+	li.each(function(_, element) {
+		let container = element.selection().closest('ul.header-icons');
+		console.log("li.each", container.html())
+	});
+}
+
+```
+{{< /code >}}