Skip to main content
Paginator for posts

Hierarquia

Construtores

constructor

new PostPaginator(fetchPage): PostPaginator Creates a new paginator instance

Parâmetros

Retorna

PostPaginator

Herdado de

Paginator.constructor

Definido em

paginator.ts:90

Acessadores

items

get items(): T[] Get all fetched items

Retorna

T[]

Herdado de

Paginator.items

Definido em

paginator.ts:97

meta

get meta(): any Get current pagination metadata

Retorna

any

Herdado de

Paginator.meta

Definido em

paginator.ts:104

includes

get includes(): undefined | Record<string, any> Get current includes data

Retorna

undefined | Record<string, any>

Herdado de

Paginator.includes

Definido em

paginator.ts:111

errors

get errors(): undefined | any[] Get current errors

Retorna

undefined | any[]

Herdado de

Paginator.errors

Definido em

paginator.ts:118

done

get done(): boolean Check if pagination is done

Retorna

boolean

Herdado de

Paginator.done

Definido em

paginator.ts:125

rateLimited

get rateLimited(): boolean Check if rate limit was hit

Retorna

boolean

Herdado de

Paginator.rateLimited

Definido em

paginator.ts:132

posts

get posts(): any[]

Retorna

any[]

Definido em

paginator.ts:342

Métodos

fetchNext

fetchNext(): Promise<void> Fetch the next page and add items to current instance This method fetches the next page of data and appends the items to the current paginator instance. It updates the pagination state and metadata.

Retorna

Promise<void> Example
Throws When the API request fails

Herdado de

Paginator.fetchNext

Definido em

paginator.ts:156

next

next(): Promise<Paginator<any>> Get next page as a new instance This method creates a new paginator instance that starts from the next page, without affecting the current paginator’s state.

Retorna

Promise<Paginator<any>> New paginator instance for the next page Example

Herdado de

Paginator.next

Definido em

paginator.ts:211

fetchPrevious

fetchPrevious(): Promise<void> Fetch previous page (if supported)

Retorna

Promise<void>

Herdado de

Paginator.fetchPrevious

Definido em

paginator.ts:225

previous

previous(): Promise<Paginator<any>> Get previous page as a new instance

Retorna

Promise<Paginator<any>>

Herdado de

Paginator.previous

Definido em

paginator.ts:260

fetchLast

fetchLast(count): Promise<void> Fetch up to a specified number of additional items

Parâmetros

Retorna

Promise<void>

Herdado de

Paginator.fetchLast

Definido em

paginator.ts:274

reset

reset(): void Reset paginator to initial state

Retorna

void

Herdado de

Paginator.reset

Definido em

paginator.ts:288

[iterator]

[iterator](): Iterator<any, any, undefined> Iterator for all fetched items

Retorna

Iterator<any, any, undefined>

Herdado de

Paginator.[iterator]

Definido em

paginator.ts:303

[asyncIterator]

[asyncIterator](): AsyncIterator<any, any, undefined> Async iterator that fetches pages automatically

Retorna

AsyncIterator<any, any, undefined>

Herdado de

Paginator.[asyncIterator]

Definido em

paginator.ts:312