Function iterateDocuments

Asynchronous generator function that iterates over documents.

Throws

If the response length is greater than the specified limit.

iterateDocuments<Data extends IRowData = IRowData>(
config: IConfig<Data>,
): AsyncGenerator<Data[], void, unknown>
Type Parameters
- Data extends IRowData = IRowData
  The type of the row data in the documents.
Parameters
- config: IConfig<Data>
  The configuration object.
  - totalDocuments
    The total number of documents to iterate over.
  - limit
    The number of documents to fetch in each request.
  - delay
    The delay between each request.
  - createRequest
    The function used to create the request.
Returns AsyncGenerator<Data[], void, unknown>
An asynchronous generator that yields an array of documents.
- Defined in types.d.ts:11194