Interface IReaderDocumentSearchQuery

execute

• execute(readerDocuments: IReaderDocument[]): ISearchResultItemIterator

• Executes the query on the specified list of ReaderDocuments and returns an iterator that can be used to fetch ISearchResultItems.

  This method is lazy and will only search as needed when fetching more items from the iterator.

  Example using a "for await" loop:

  const searchResultIterator = query.execute(readerView.getReaderDocuments());
  
  for await (const searchResultItem of searchResultIterator) {
      // Do something with searchResultItem
  }
  

  Example using ISearchResultItemIterator.take() to get up to 10 search result items:

  const searchResultIterator = query.execute(readerView.getReaderDocuments());
  const firstTenResultItems = await searchResultIterator.take(10);
  

  Example using ISearchResultItemIterator.takeRemaining():

  const searchResultIterator = query.execute(readerView.getReaderDocuments());
  const allResultItems = await searchResultIterator.takeRemaining();
  

  Parameters

  • readerDocuments: IReaderDocument[]

  Returns ISearchResultItemIterator