k6/html on Grafana Labs

parseHTML( src )

Mon, 21 Sep 2026 15:16:28 +0000

parseHTML( src )

Parse an HTML string and populate a Selection object.

Parameter	Type	Description
src	string	HTML source.

Returns

Type	Description
Selection	A Selection object.

Example

import { parseHTML } from 'k6/html';
import http from 'k6/http';

export default function () {
  const res = http.get('https://k6.io');
  const doc = parseHTML(res.body); // equivalent to res.html()
  const pageTitle = doc.find('head title').text();
  const langAttr = doc.find('html').attr('lang');
}

Element

Mon, 21 Sep 2026 15:16:28 +0000

Element

Represents a DOM element matched by a Selection, and provides an API to inspect the element content.

Use Selection.get(index) to return an Element object.

The Element object provides a similar API to the DOM Element API to retrieve element information.

Method	Description
selection	The selection matching the element.
nodeName	The name of the element.
nodeType	The type of the element.
nodeValue	The element value.
id	The id of the element.
innerHTML	Is a DOMString representing the markup of the element’s content.
textContent	The element content.
ownerDocument	Element
attributes	An array of attributes.
firstChild	Element
lastChild	Element
childElementCount	The number of children elements.
firstElementChild	Element
lastElementChild	Element
previousSibling	Element
nextSibling	Element
previousElementSibling	Element
nextElementSibling	Element
parentElement	Element
parentNode	Element
childNodes	Array of Element
children	Array of Element
classList	An array of class names.
className	The class name string
lang	The value of the lang attribute.
toString	The element string representation.
hasAttribute	Boolean
getAttribute	getAttributeNode
hasAttributes	Boolean
hasChildNodes	Boolean
isSameNode	Boolean
isEqualNode	Boolean
getElementsByClassName	Return an array of Element.
getElementsByTagName	Return an array of Element.
querySelector	Returns the first Element which matches the specified selector string relative to the element
querySelectorAll	Returns all the Element which matches the specified selector string relative to the element
contains
matches	Returns a Boolean indicating whether or not the element would be selected by the specified selector string
namespaceURI	The namespace URI of the element.
isDefaultNamespace	Returns a Boolean indicating whether the element has the default namespace.

Additionally, Element can provide more methods depending on the Element type.

AnchorElement: hash, host, hostname, port, username, password, origin, pathname, protocol, relist, search, text.
ButtonElement: form, formAction, formEnctype, formMethod, formNoValidate, formTarget, labels, name, value.
CanvasElement: width, height
DataListElement: options
FieldSetElement: elements, type, form
FormElement: elements, length, method
InputElement: form
LabelElement: control, form
LegendElement: form
LinkElement: relList
MapElement: areas, images
ObjectElement: form
OptionElement: disabled, form, index, label, text, value
OutputElement: value, labels
ProgressElement: max, value, position
ScriptElement: text
SelectElement: form, length, options, selectedOptions, selectedIndex, value
StyleElement: text
TableElement: caption, thead, tbody, tfoot, rows
TableCellElement: cellIndex, colSpan, rowSpan, headers
TableRowElement: cells, colSpan, sectionRowIndex, rowIndex
VideoElement: textTracks
TitleElement: text

Example

import { parseHTML } from 'k6/html';
import { sleep } from 'k6';

export default function () {
  const content = `
<dl>
  <dt id="term-1">Value term 1</dt>
  <dt id="term-2">Value term 2</dt>
</dl>
  `;
  const sel = parseHTML(content).find('dl').children();

  const el1 = sel.get(0);
  const el2 = sel.get(1);

  console.log(el1.nodeName());
  console.log(el1.id());
  console.log(el1.textContent());

  console.log(el2.nodeName());
  console.log(el2.id());
  console.log(el2.textContent());

  sleep(1);
}

import { parseHTML } from 'k6/html';
import { sleep } from 'k6';

export default function () {
  const content = `
\t<a href="http://username:password@example.com:80" rel="prev next" target="_self" type="rare" accesskey="q" hreflang="en-US" media="print">6</a> <!-- trufflehog:ignore -->
  `;
  const el = parseHTML(content).find('a').get(0);

  console.log(el.nodeName());
  console.log(el.innerHTML());
  console.log(el.host());
  console.log(el.hostname());
  console.log(el.protocol());

  sleep(1);
}

Selection

Mon, 21 Sep 2026 15:16:28 +0000

Selection

Represents a set of nodes in a DOM tree.

Selections have a jQuery-compatible API, but with two caveats:

CSS and screen layout are not processed, thus calls like css() and offset() are unavailable.
DOM trees are read-only, you can’t set attributes or otherwise modify nodes.

(Note that the read-only nature of the DOM trees is purely to avoid a maintenance burden on code with seemingly no practical use - if a compelling use case is presented, modification can easily be implemented.)

Method	Description
Selection.attr(name)	Get the value of an attribute for the first element in the Selection.
Selection.children([selector])	Get the children of each element in the set of matched elements, optionally filtered by a selector.
Selection.closest(selector)	Get the first element that matches the selector by testing the element itself and traversing up through its ancestors
Selection.contents()	Get the children of each element in the set of matched elements, including text and comment nodes.
Selection.data([key])	Return the value at the named data store for the first element in the set of matched elements.
Selection.each(fn)	Iterate and execute a function for each matched element.
Selection.eq(index)	Reduce the set of matched elements to the one at the specified index.
Selection.filter(selector)	Reduce the set of matched elements to those that match the selector or pass the function’s test.
Selection.find(selector)	Find the selection descendants, filtered by a selector.
Selection.first()	Reduce the set of matched elements to the first in the set.
Selection.get(index)	Retrieve the Element (k6/html) matched by the selector
Selection.has(selector)	Reduce the set of matched elements to those that have a descendant that matches the selector
Selection.html()	Get the HTML contents of the first element in the set of matched elements
Selection.is(selector)	Check the current matched set of elements against a selector or element and return true if at least one of these elements matches the given arguments.
Selection.last()	Reduce the set of matched elements to the final one in the set.
Selection.map(fn)	Pass each selection in the current matched set through a function, producing a new Array containing the return values.
Selection.nextAll([selector])	Get all following siblings of each element in the set of matched elements, optionally filtered by a selector.
Selection.next([selector])	Get the immediately following sibling of each element in the set of matched element
Selection.nextUntil([selector], [filter])	Get all following siblings of each element up to but not including the element matched by the selector.
Selection.not(selector)	Remove elements from the set of matched elements
Selection.parent([selector])	Get the parent of each element in the current set of matched elements, optionally filtered by a selector.
Selection.parents([selector])	Get the ancestors of each element in the current set of matched elements, optionally filtered by a selector.
Selection.parentsUntil([selector], [filter])	Get the ancestors of each element in the current set of matched elements, up to but not including the element matched by the selector.
Selection.prevAll([selector])	Get all preceding siblings of each element in the set of matched elements, optionally filtered by a selector.
Selection.prev([selector])	Get the immediately preceding sibling of each element in the set of matched elements.
Selection.prevUntil([selector], [filter])	Get all preceding siblings of each element up to but not including the element matched by the selector.
Selection.serialize()	Encode a set of form elements as a string in standard URL-encoded notation for submission.
Selection.serializeArray()	Encode a set of form elements as an array of names and values.
Selection.serializeObject()	Encode a set of form elements as an object.
Selection.single(selector)	Returns at most one element matching the selector.
Selection.size()	Return the number of elements in the Selection.
Selection.slice(start [, end])	Reduce the set of matched elements to a subset specified by a range of indices.
Selection.text()	Get the text content of the selection.
Selection.toArray()	Retrieve all the elements contained in the Selection, as an array.
Selection.val()	Get the current value of the first element in the set of matched elements.

Example

import { parseHTML } from 'k6/html';
import http from 'k6/http';

export default function () {
  const res = http.get('https://k6.io');
  const doc = parseHTML(res.body);
  const pageTitle = doc.find('head title').text();
  const langAttr = doc.find('html').attr('lang');
}