@azure-rest/core-client-paging package
Interfaces
| PagedAsyncIterableIterator |
Uma interface que permite iteração assíncrona iterável tanto para conclusão quanto por página. |
| PaginateOptions |
Opções para indicar valores personalizados para onde procurar nextLink e valores ao paginar uma resposta |
Funções
| paginate |
Auxiliar para iterar respostas pagináveis |
Detalhes da função
paginateResponse<TReturn>(Client, HttpResponse, PaginateOptions)
Auxiliar para iterar respostas pagináveis
function paginateResponse<TReturn>(client: Client, initialResponse: HttpResponse, options?: PaginateOptions): PagedAsyncIterableIterator<TReturn, TReturn[]>Parâmetros
- client
- Client
Cliente a ser usado para enviar a solicitação para obter páginas adicionais
- initialResponse
- HttpResponse
A resposta inicial
- options
- PaginateOptions
Opções para usar nomes de propriedade personalizados para paginação
Retornos
PagedAsyncIterableIterator<TReturn, TReturn[]>
- retornar um PagedAsyncIterableIterator que pode ser usado para iterar os elementos
