@azure-rest/core-client-paging package

Schnittstellen

PagedAsyncIterableIterator

Eine Schnittstelle, die eine asynchrone iterierbare Iteration sowohl zum Abschluss als auch nach Seite ermöglicht.

PaginateOptions

Optionen zum Angeben von benutzerdefinierten Werten für die Suche nach nextLink und Werten beim Paginieren einer Antwort

Functions

paginateResponse<TReturn>(Client, HttpResponse, PaginateOptions)

Hilfsprogramm zum Durchlaufen von seitenfähigen Antworten

Details zur Funktion

paginateResponse<TReturn>(Client, HttpResponse, PaginateOptions)

Hilfsprogramm zum Durchlaufen von seitenfähigen Antworten

function paginateResponse<TReturn>(client: Client, initialResponse: HttpResponse, options?: PaginateOptions): PagedAsyncIterableIterator<TReturn, TReturn[]>

Parameter

client
Client

Client, der zum Senden der Anforderung zum Abrufen zusätzlicher Seiten verwendet werden soll

initialResponse
HttpResponse

Die erste Antwort

options
PaginateOptions

Optionen für die Verwendung von benutzerdefinierten Eigenschaftennamen für die Paginierung

Gibt zurück

PagedAsyncIterableIterator<TReturn, TReturn[]>

  • Zurückgeben eines PagedAsyncIterableIterator, der zum Durchlaufen der Elemente verwendet werden kann