Skip to main content
Paginator for posts

階層

コンストラクター

コンストラクター

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

パラメーター

戻り値

PostPaginator

継承元

Paginator.constructor

定義場所

paginator.ts:90

Accessors

items

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

戻り値

T[]

継承元

Paginator.items

定義場所

paginator.ts:97

meta

get meta(): any Get current pagination metadata

戻り値

any

継承元

Paginator.meta

定義場所

paginator.ts:104

includes

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

戻り値

undefined | Record<string, any>

継承元

Paginator.includes

定義場所

paginator.ts:111

errors

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

戻り値

undefined | any[]

継承元

Paginator.errors

定義場所

paginator.ts:118

done

get done(): boolean Check if pagination is done

戻り値

boolean

継承元

Paginator.done

定義場所

paginator.ts:125

rateLimited

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

戻り値

boolean

継承元

Paginator.rateLimited

定義場所

paginator.ts:132

posts

get posts(): any[]

戻り値

any[]

定義場所

paginator.ts:342

メソッド

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.

戻り値

Promise<void> Example
Throws When the API request fails

継承元

Paginator.fetchNext

定義場所

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.

戻り値

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

継承元

Paginator.next

定義場所

paginator.ts:211

fetchPrevious

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

戻り値

Promise<void>

継承元

Paginator.fetchPrevious

定義場所

paginator.ts:225

previous

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

戻り値

Promise<Paginator<any>>

継承元

Paginator.previous

定義場所

paginator.ts:260

fetchLast

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

パラメーター

戻り値

Promise<void>

継承元

Paginator.fetchLast

定義場所

paginator.ts:274

reset

reset(): void Reset paginator to initial state

戻り値

void

継承元

Paginator.reset

定義場所

paginator.ts:288

[iterator]

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

戻り値

Iterator<any, any, undefined>

継承元

Paginator.[iterator]

定義場所

paginator.ts:303

[asyncIterator]

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

戻り値

AsyncIterator<any, any, undefined>

継承元

Paginator.[asyncIterator]

定義場所

paginator.ts:312