temporal.documentPeriod

temporal.documentperiodtemporaldocumentperiod

/apidoc/8.0/temporal:document-period.xml

This function returns the period (as a dateTime pair) for the named axis in the document identified by its root node in the named collection.

An TEMPORAL-NOAXISINFO exception is thrown if no information is found in root for the axis.

The name of the temporal collection.

temporal-collection

String

The name of axis from which to get the period.

axis

String

The root node of the document.

root

Node

ValueIterator

var temporal = require("/MarkLogic/temporal.xqy");
temporal.documentPeriod("temporal", "valid", 
  cts.doc("clue.xml.7788866244426452375"));

=> Returns the period for the valid axis set for the document, 
   "clue.xml.7788866244426452375".