index.md

layout	default
menu_item	api
title	IndexIterator
description	Version 0.26.1
return_to	API Documentation Index /api/
sections	create #next #create #next

IndexIterator.create AsyncExperimental

IndexIterator.create(index).then(function(indexIterator) {
  // Use indexIterator
});

Parameters	Type
index	Index	The index to iterate

Returns
IndexIterator	The newly created iterator

IndexIterator#next SyncExperimental

var indexEntry = indexIterator.next();

Returns
IndexEntry