PagedResult interface
Interfaccia che descrive come comunicare con il servizio.
Proprietà
| by |
funzione per implementare il metodo |
| first |
Collegamento alla prima pagina dei risultati. |
| get |
Metodo che restituisce una pagina di risultati. |
| to |
Funzione per estrarre elementi da una pagina. |
Dettagli proprietà
byPage
funzione per implementare il metodo byPage nell'iteratore asincrono di paging. Il valore predefinito è uno che imposta il maxPageSizeParam da settings.maxPageSize.
byPage?: (settings?: TPageSettings) => AsyncIterableIterator<TPage>
Valore della proprietà
(settings?: TPageSettings) => AsyncIterableIterator<TPage>
firstPageLink
Collegamento alla prima pagina dei risultati.
firstPageLink: TLink
Valore della proprietà
TLink
getPage
Metodo che restituisce una pagina di risultati.
getPage: (pageLink: TLink, maxPageSize?: number) => Promise<undefined | { nextPageLink?: TLink, page: TPage }>
Valore della proprietà
(pageLink: TLink, maxPageSize?: number) => Promise<undefined | { nextPageLink?: TLink, page: TPage }>
toElements
Funzione per estrarre elementi da una pagina.
toElements?: (page: TPage) => unknown[]
Valore della proprietà
(page: TPage) => unknown[]