@azure-rest/core-client-paging package
Interfaces
| PagedAsyncIterableIterator |
Interface qui permet une itération itérable asynchrone à la fois à l’achèvement et à la page. |
| PaginateOptions |
Options permettant d’indiquer des valeurs personnalisées où rechercher nextLink et les valeurs lors de la pagination d’une réponse |
Functions
| paginate |
Assistance pour itérer les réponses paginables |
Informations relatives à la fonction
paginateResponse<TReturn>(Client, HttpResponse, PaginateOptions)
Assistance pour itérer les réponses paginables
function paginateResponse<TReturn>(client: Client, initialResponse: HttpResponse, options?: PaginateOptions): PagedAsyncIterableIterator<TReturn, TReturn[]>Paramètres
- client
- Client
Client à utiliser pour envoyer la demande pour obtenir des pages supplémentaires
- initialResponse
- HttpResponse
Réponse initiale
- options
- PaginateOptions
Options permettant d’utiliser des noms de propriétés personnalisés pour la pagination
Retours
PagedAsyncIterableIterator<TReturn, TReturn[]>
- renvoyer un PagedAsyncIterableIterator qui peut être utilisé pour itérer les éléments
