Missing acceptNode function in NodeFilter interface

[falconepl]

It seems that acceptNode function has been accidentally removed from NodeFilter interface for DOM (see dom.generated.d.ts file). That might be due to 1dacb54.

[falconepl]

And by the way... am I missing something or when you want to provide your own NodeFilter implementation to use it for example in document.createNodeIterator(root, whatToShow, filter) call, you have to make it this way:

class CustomFilter implements NodeFilter {
    acceptNode(n:Node) { return NodeFilter.FILTER_ACCEPT }

    // ...with all that boilerplate
    SHOW_ENTITY_REFERENCE: number;
    SHOW_NOTATION: number;
    SHOW_ENTITY: number;
    SHOW_DOCUMENT: number;
    SHOW_PROCESSING_INSTRUCTION: number;
    FILTER_REJECT: number;
    SHOW_CDATA_SECTION: number;
    FILTER_ACCEPT: number;
    SHOW_ALL: number;
    SHOW_DOCUMENT_TYPE: number;
    SHOW_TEXT: number;
    SHOW_ELEMENT: number;
    SHOW_COMMENT: number;
    FILTER_SKIP: number;
    SHOW_ATTRIBUTE: number;
    SHOW_DOCUMENT_FRAGMENT: number;
}

var customFilter = new CustomFilter();

document.createNodeIterator(document.body, NodeFilter.SHOW_TEXT, customFilter);

?

Is having:

// does not implement NodeFilter
class ShorterFilter {
    acceptNode(n:Node) { return NodeFilter.FILTER_ACCEPT }
}

var shorterFilter = new ShorterFilter();

document.createNodeIterator(document.body, NodeFilter.SHOW_TEXT, <any> shorterFilter);

the only way to avoid retyping all of these property types? By the way, it's kind of interesting that an argument of type any (shorterFilter) can be passed as a third parameter of type NodeFilter.

Maybe the signature of Document.createNodeIterator from:

createNodeIterator(root: Node, whatToShow?: number, filter?: NodeFilter, entityReferenceExpansion?: boolean): NodeIterator

should be changed to:

createNodeIterator(root: Node, whatToShow?: number, filter?: { acceptNode(n: Node): number }, entityReferenceExpansion?: boolean): NodeIterator

?

That would let us avoid being more verbose that JavaScript is in the case of custom NodeFilter creation - an example.

[danquirk]

Spec link: https://developer.mozilla.org/en-US/docs/Web/API/NodeFilter/acceptNode

[zhengbli]

Indeed this is a bug. These constants are supposed to be in the static side of the interface, it should be:

interface NodeFilter {
    acceptNode(n: Node): number;
}

declare var NodeFilter: {
    prototype: NodeFilter;
    FILTER_ACCEPT: number;
    FILTER_REJECT: number;
    FILTER_SKIP: number;
    SHOW_ALL: number;
    SHOW_ATTRIBUTE: number;
    SHOW_CDATA_SECTION: number;
    SHOW_COMMENT: number;
    SHOW_DOCUMENT: number;
    SHOW_DOCUMENT_FRAGMENT: number;
    SHOW_DOCUMENT_TYPE: number;
    SHOW_ELEMENT: number;
    SHOW_ENTITY: number;
    SHOW_ENTITY_REFERENCE: number;
    SHOW_NOTATION: number;
    SHOW_PROCESSING_INSTRUCTION: number;
    SHOW_TEXT: number;
}

And then you can do:

class CustomFilter implements NodeFilter {
    acceptNode(n: Node) { return NodeFilter.FILTER_ACCEPT }
}

Will fix soon.

Edit: As NodeFilter is a static interface, it should not have a constructor (confirmed in browser that new Nodefilter() is illegal).

[falconepl]

Agree. That's exactly what we need.