TreeWalker: filter property

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

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

Specifications

Browser compatibility

See also

• The TreeWalker interface it belongs to.