Class: Iterator

"intersystems-iris-native".Iterator

Source:

Methods

entries() → {external:"intersystems-iris-native".Iterator}

set the iterator return type to return entries where each value is an array containing the subscript and node value, returns This() for chaining.
Source:
Returns:
Type
external:"intersystems-iris-native".Iterator

keys() → {external:"intersystems-iris-native".Iterator}

set the iterator return type to return keys only (subscripts), returns this() for chaining.
Source:
Returns:
Type
external:"intersystems-iris-native".Iterator

next() → {any}

Position the iterator at the next sibling node in collation order and return an object containing done and value properties. If the iterator is at end then done is true, otherwise it is false. The value property returned when done is false is either the subscript, the node value, or an array whose first element is the subscript and the second is the global node value. The return value type defaults to the array containing the subscript and value. The return type can be changed by invoking the entries(), keys(), or values() methods.
Source:
Returns:
Type
any

reversed() → {external:"intersystems-iris-native".Iterator}

reverse the iterator, returns this() for chaining.
Source:
Returns:
Type
external:"intersystems-iris-native".Iterator

startFrom(subscript) → {external:"intersystems-iris-native".Iterator}

Position the iterator to start from subscript, returns this() for chaining.
Parameters:
Name Type Description
subscript string the value of the subscript where the iterator is to be positioned
Source:
Returns:
Type
external:"intersystems-iris-native".Iterator

values() → {external:"intersystems-iris-native".Iterator}

set the iterator return type to return only values, returns this() for chaining.
Source:
Returns:
Type
external:"intersystems-iris-native".Iterator

© 2020 InterSystems Corporation, Cambridge, MA. All rights reserved.    Privacy & Terms Guarantee Section 508