TreeWalker: filter property

Baseline Widely available

This feature is well established and works across many devices and browser versions. It’s been available across browsers since July 2015.

The TreeWalker.filter read-only property returns the NodeFilter associated with the TreeWalker.

When creating the TreeWalker, the filter object is passed in as the third parameter, and its method acceptNode() is called on every single node to determine whether or not to accept it.

Value

A NodeFilter object.

Examples

js
const treeWalker = document.createTreeWalker(
  document.body,
  NodeFilter.SHOW_ELEMENT,
  {
    acceptNode(node) {
      return NodeFilter.FILTER_ACCEPT;
    },
  },
);
nodeFilter = treeWalker.filter; // document.body in this case

Specifications

Specification
DOM Standard
# dom-treewalker-filter

Browser compatibility

BCD tables only load in the browser

See also