NodeIterator: 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 NodeIterator.filter
read-only property returns a
NodeFilter
object, that is an object which implements an
acceptNode(node)
method, used to screen nodes.
When creating the NodeIterator
, the filter object is passed in as the
third parameter, and the object method acceptNode(node)
is
called on every single node to determine whether or not to accept it. This function
should return the constant NodeFilter.FILTER_ACCEPT
for cases when the
node should be accepted and NodeFilter.FILTER_REJECT
for cases when the
node should be rejected.
Value
A NodeFilter
object.
Examples
const nodeIterator = document.createNodeIterator(
document.body,
NodeFilter.SHOW_ELEMENT,
{
acceptNode(node) {
return NodeFilter.FILTER_ACCEPT;
},
},
);
nodeFilter = nodeIterator.filter;
Specifications
Specification |
---|
DOM Standard # dom-nodeiterator-filter |
Browser compatibility
BCD tables only load in the browser
See also
- The interface this property belongs to:
NodeIterator
.