← Back to DOM domain

DOM.performSearch

Searches for a given string in the DOM tree. Use `getSearchResults` to access search results or `cancelSearch` to end this search session.

Domain: DOM experimental

Parameters

NameTypeDescription
querystringPlain text or query selector or XPath search query.
includeUserAgentShadowDOM (optional)booleanTrue to search in user agent shadow DOM.

Returns

NameTypeDescription
searchIdstringUnique search session identifier.
resultCountintegerNumber of search results.

Example Request

{
  "id": 1,
  "method": "DOM.performSearch",
  "params": {
    "query": "query-value"
  }
}

Example Response

{
  "id": 1,
  "result": {
    "searchId": "searchId-value",
    "resultCount": 1
  }
}

Usage in Node.js

const result = await send('DOM.performSearch', {"query": "query-value"});
console.log(result);
// {"searchId": "searchId-value", "resultCount": 1}