Interface PagedAsyncIterableIterator<T, PageT>

Package version

interface: An interface that allows async iterable iteration both to completion and by page.

Type parameters

T
PageT

Hierarchy

PagedAsyncIterableIterator

Index

Properties

byPage

Methods

Properties

byPage

byPage: function

member: {Function} [byPage] Return an AsyncIterableIterator that works a page at a time

Type declaration

- (settings?: PageSettings): AsyncIterableIterator<PageT extends never ? T[] : PageT>
- Parameters
  - Optional settings: PageSettings
  Returns AsyncIterableIterator<PageT extends never ? T[] : PageT>

Methods

__@asyncIterator

__@asyncIterator(): PagedAsyncIterableIterator<T, PageT>

- Defined in core/core-paging/types/corePaging.d.ts:31
member

{Symbol} [asyncIterator] The connection to the async iterator, part of the iteration protocol

Returns PagedAsyncIterableIterator<T, PageT>

next

next(): Promise<object>

- Defined in core/core-paging/types/corePaging.d.ts:24
member

{Promise} [next] The next method, part of the iteration protocol

Returns Promise<object>

Generated using TypeDoc