InsightArrayIterator

Method summary

Methods

moveBefore ( ) → {InsightArrayIterator}

Position the cursor so that the next element returned will be the one specified by the passed in key. If the key does not exist then there is no change to the cursor position.

Returns:

Type	Description
InsightArrayIterator	the iterator to allow chaining commands

Example

var key = [4]; // 4th item
var arr = scenario.getArray('INTEGER_ARRAY');
array.moveBefore(key);
array.next(); // fourth item returned

Back to Top

moveBeforeFirst ( ) → {InsightArrayIterator}

Resets the iterator back to the start.

Returns:

Type	Description
InsightArrayIterator	the iterator to allow chaining commands

Example

var arr = scenario.getArray('INTEGER_ARRAY');
array.next(); // first item
array.next(); // second item
array.next(); // third item
array.moveBeforeFirst(); // reset the cursor
array.next(); // first item
array.next(); // second item

Back to Top

next ( ) → {Object.<{key: Array.<(string|number|boolean)>, value: (string|number|boolean)}>|undefined}

Retrieves the next element in the Insight Array.

Returns:

Type	Description
Object.<{key: Array.<(string|number|boolean)>, value: (string|number|boolean)}> | undefined	Undefined if end of data

Example

var arr = scenario.getArray('INTEGER_ARRAY');
var keyValueObject;
while (keyValueObject = array.next()) {
     // do something with value
}

Back to Top