Compartilhar via


@azure/core-paging package

Interfaces

PageSettings

Uma interface que rastreia as configurações da iteração paginada

PagedAsyncIterableIterator

Uma interface que permite iteração assíncrona iterável tanto para conclusão quanto por página.

PagedResult

Uma interface que descreve como se comunicar com o serviço.

Aliases de tipo

Paged

Coleção de páginas de itens T

Funções

getPagedAsyncIterator<TElement, TPage, TPageSettings, TLink>(PagedResult<TPage, TPageSettings, TLink>)

retorna um iterador assíncrono que itera sobre os resultados. Ele também tem um método byPage que retorna páginas de itens ao mesmo tempo.

Detalhes da função

getPagedAsyncIterator<TElement, TPage, TPageSettings, TLink>(PagedResult<TPage, TPageSettings, TLink>)

retorna um iterador assíncrono que itera sobre os resultados. Ele também tem um método byPage que retorna páginas de itens ao mesmo tempo.

function getPagedAsyncIterator<TElement, TPage, TPageSettings, TLink>(pagedResult: PagedResult<TPage, TPageSettings, TLink>): PagedAsyncIterableIterator<TElement, TPage, TPageSettings>

Parâmetros

pagedResult

PagedResult<TPage, TPageSettings, TLink>

um objeto que especifica como obter páginas.

Retornos

PagedAsyncIterableIterator<TElement, TPage, TPageSettings>

um iterador assíncrono paginado que itera sobre os resultados.