Interface ISearchResultItemIterator

An async iterator type that allows you to fetch ISearchResultItem objects. An instance of this type is returned when calling IReaderDocumentSearchQuery.execute().

Hierarchy

AsyncIterableIterator<ISearchResultItem>
- ISearchResultItemIterator

Index

Methods

Methods

[asyncIterator]

[asyncIterator](): AsyncIterableIterator<ISearchResultItem>

Inherited from AsyncIterableIterator.__@asyncIterator@260988
Returns AsyncIterableIterator<ISearchResultItem>

next

next(...args: [] | [undefined]): Promise<IteratorResult<ISearchResultItem, any>>

Inherited from AsyncIterableIterator.next
Parameters
- Rest ...args: [] | [undefined]
Returns Promise<IteratorResult<ISearchResultItem, any>>

Optional return

return(value?: any): Promise<IteratorResult<ISearchResultItem, any>>

Inherited from AsyncIterableIterator.return
Parameters
- Optional value: any
Returns Promise<IteratorResult<ISearchResultItem, any>>

take

take(numberOfItems: number): Promise<ISearchResultItem[]>

Takes the specified number of items from this iterator. This method will return fewer items if no more are available.
Example:
```
const items = iterator.take(10);
if (items.length < 10) {
    // End of iterator reached.
}
```
Parameters
- numberOfItems: number
Returns Promise<ISearchResultItem[]>

takeRemaining

takeRemaining(): Promise<ISearchResultItem[]>

Takes all remaining items from this iterator. In an "untouched" iterator, this is the same as taking all search result items. Note that this operation can be expensive since all ReaderDocuments will be processed.

Returns Promise<ISearchResultItem[]>

Optional throw

throw(e?: any): Promise<IteratorResult<ISearchResultItem, any>>

Inherited from AsyncIterableIterator.throw
Parameters
- Optional e: any
Returns Promise<IteratorResult<ISearchResultItem, any>>

Generated using TypeDoc