Module common/lib/paginators
Functions
findNextPageToken
- findNextPageToken(res: any): string
-
Parameters
Returns string
findResult
- findResult(res: any): any
findSetPageToken
- findSetPageToken(req: any, nextPageToken: string): void
-
Parameters
-
req: any
-
nextPageToken: string
Returns void
genericPaginate
- genericPaginate<ListRequest, ListResponse, TResult>(request: ListRequest, listCall: function, getNextPageToken: function, setNextPageToken: function, getResults: function, limitedRecord?: undefined | number): AsyncIterableIterator<TResult>
-
Type parameters
-
-
ListResponse
-
TResult: object
Parameters
-
request: ListRequest
-
listCall: function
-
- (request: ListRequest): Promise<ListResponse>
-
Parameters
Returns Promise<ListResponse>
-
getNextPageToken: function
-
- (response: ListResponse): string | undefined
-
Parameters
Returns string
|
undefined
-
setNextPageToken: function
-
- (request: ListRequest, nextPageToken: string): void
-
Parameters
-
request: ListRequest
-
nextPageToken: string
Returns void
-
getResults: function
-
- (response: ListResponse): TResult[]
-
Parameters
Returns TResult[]
-
Optional limitedRecord: undefined | number
Returns AsyncIterableIterator<TResult>
genericPaginateRecords
- genericPaginateRecords<ListRequest, ListResponse, ItemSummary>(request: ListRequest, listCall: function, getNextPageToken: function, setNextPageToken: function, getItems: function, limitedRecord?: undefined | number): AsyncIterableIterator<ItemSummary>
-
Type parameters
-
ListRequest
-
ListResponse
-
ItemSummary
Parameters
-
request: ListRequest
-
listCall: function
-
- (request: ListRequest): Promise<ListResponse>
-
Parameters
Returns Promise<ListResponse>
-
getNextPageToken: function
-
- (response: ListResponse): string | undefined
-
Parameters
Returns string
|
undefined
-
setNextPageToken: function
-
- (request: ListRequest, nextPageToken: string): void
-
Parameters
-
request: ListRequest
-
nextPageToken: string
Returns void
-
getItems: function
-
- (response: ListResponse): ItemSummary[]
-
Parameters
Returns ItemSummary[]
-
Optional limitedRecord: undefined | number
Returns AsyncIterableIterator<ItemSummary>
genericPaginateResponses
- genericPaginateResponses<ListRequest, ListResponse>(request: ListRequest, listCall: function, getNextPageToken: function, setNextPageToken: function, limitedRecord?: undefined | number): AsyncIterableIterator<ListResponse>
-
Type parameters
Parameters
-
request: ListRequest
-
listCall: function
-
- (request: ListRequest): Promise<ListResponse>
-
Parameters
Returns Promise<ListResponse>
-
getNextPageToken: function
-
- (response: ListResponse): string | undefined
-
Parameters
Returns string
|
undefined
-
setNextPageToken: function
-
- (request: ListRequest, nextPageToken: string): void
-
Parameters
-
request: ListRequest
-
nextPageToken: string
Returns void
-
Optional limitedRecord: undefined | number
Returns AsyncIterableIterator<ListResponse>
paginateRecords
- paginateRecords<ListRequest, ListResponse, ItemSummary>(request: ListRequest, listCall: function, limitedRecord?: undefined | number): AsyncIterableIterator<ItemSummary>
-
Type parameters
Parameters
-
request: ListRequest
-
listCall: function
-
- (request: ListRequest): Promise<ListResponse>
-
Parameters
Returns Promise<ListResponse>
-
Optional limitedRecord: undefined | number
Returns AsyncIterableIterator<ItemSummary>
paginateResponses
- paginateResponses<ListRequest, ListResponse>(request: ListRequest, listCall: function, limitedRecord?: undefined | number): AsyncIterableIterator<ListResponse>
-
Type parameters
Parameters
-
request: ListRequest
-
listCall: function
-
- (request: ListRequest): Promise<ListResponse>
-
Parameters
Returns Promise<ListResponse>
-
Optional limitedRecord: undefined | number
Returns AsyncIterableIterator<ListResponse>
paginatedRecordsWithLimit
- paginatedRecordsWithLimit<ListRequest, ListResponse>(request: ListRequest, listCall: function, limitedRecord?: undefined | number): Promise<IteratorYieldResult<any>[]>
-
Type parameters
Parameters
-
request: ListRequest
-
listCall: function
-
- (request: ListRequest): Promise<ListResponse>
-
Parameters
Returns Promise<ListResponse>
-
Optional limitedRecord: undefined | number
Returns Promise<IteratorYieldResult<any>[]>
paginatedResponsesWithLimit
- paginatedResponsesWithLimit<ListRequest, ListResponse>(request: ListRequest, listCall: function, limitedRecord?: undefined | number): Promise<any>
-
Type parameters
Parameters
-
request: ListRequest
-
listCall: function
-
- (request: ListRequest): Promise<ListResponse>
-
Parameters
Returns Promise<ListResponse>
-
Optional limitedRecord: undefined | number
Returns Promise<any>