A user account is required in order to edit this wiki, but we've had to disable public user registrations due to spam.

To request an account, ask an autoconfirmed user on Chat (such as one of these permanent autoconfirmed members).

Difference between revisions of "DOM XPath"

From WHATWG Wiki
Jump to navigation Jump to search
(singleNodeValue is nullable per the spec and actual browser behavior)
(evaluate() accepts XPathResult object)
Line 53: Line 53:
                               optional XPathNSResolver? resolver,  
                               optional XPathNSResolver? resolver,  
                               optional unsigned short type,  
                               optional unsigned short type,  
                               optional object? result);
                               optional XPathResult? result);
};
};



Revision as of 14:04, 4 March 2019

If someone ever decides to write down DOM XPath (i.e. a proper version of the DOM3XPath note), take this into account:

WebIDL interfaces

[Exposed=Window]
interface XPathResult {
  const unsigned short      ANY_TYPE                       = 0;
  const unsigned short      NUMBER_TYPE                    = 1;
  const unsigned short      STRING_TYPE                    = 2;
  const unsigned short      BOOLEAN_TYPE                   = 3;
  const unsigned short      UNORDERED_NODE_ITERATOR_TYPE   = 4;
  const unsigned short      ORDERED_NODE_ITERATOR_TYPE     = 5;
  const unsigned short      UNORDERED_NODE_SNAPSHOT_TYPE   = 6;
  const unsigned short      ORDERED_NODE_SNAPSHOT_TYPE     = 7;
  const unsigned short      ANY_UNORDERED_NODE_TYPE        = 8;
  const unsigned short      FIRST_ORDERED_NODE_TYPE        = 9;

  readonly attribute unsigned short resultType;
  readonly attribute unrestricted double numberValue;
  // Maybe "DOMString?".
  readonly attribute DOMString stringValue;
  readonly attribute boolean booleanValue;
  readonly attribute Node? singleNodeValue;
  readonly attribute boolean          invalidIteratorState;
  readonly attribute unsigned long    snapshotLength;
  Node?               iterateNext();
  Node?               snapshotItem(unsigned long index);
};

[Exposed=Window]
interface XPathExpression {
  XPathResult evaluate(Node contextNode,
                       optional unsigned short type,
                       optional object? result);
};

callback interface XPathNSResolver {
  DOMString? lookupNamespaceURI(DOMString? prefix);
};

interface mixin XPathEvaluatorBase {
  XPathExpression    createExpression(DOMString expression, 
                                      optional XPathNSResolver? resolver);
  XPathNSResolver    createNSResolver(Node nodeResolver);
  XPathResult        evaluate(DOMString expression, 
                              Node contextNode, 
                              optional XPathNSResolver? resolver, 
                              optional unsigned short type, 
                              optional XPathResult? result);
};

[Exposed=Window, Constructor]
interface XPathEvaluator {};

XPathEvaluator includes XPathEvaluatorBase;
Document includes XPathEvaluatorBase;

Indeed, you can both construct this object and access its methods on Document. Isn't the world wonderful?