階層
-
Paginator<any> ↳UserPaginator
コンストラクター
コンストラクター
• new UserPaginator(fetchPage): UserPaginator
Creates a new paginator instance
パラメーター
戻り値
UserPaginator
継承元
Paginator.constructor定義場所
paginator.ts:90Accessors
items
•get items(): T[]
Get all fetched items
戻り値
T[]
継承元
Paginator.items定義場所
paginator.ts:97meta
•get meta(): any
Get current pagination metadata
戻り値
any
継承元
Paginator.meta定義場所
paginator.ts:104includes
•get includes(): undefined | Record<string, any>
Get current includes data
戻り値
undefined | Record<string, any>
継承元
Paginator.includes定義場所
paginator.ts:111errors
•get errors(): undefined | any[]
Get current errors
戻り値
undefined | any[]
継承元
Paginator.errors定義場所
paginator.ts:118done
•get done(): boolean
Check if pagination is done
戻り値
boolean
継承元
Paginator.done定義場所
paginator.ts:125rateLimited
•get rateLimited(): boolean
Check if rate limit was hit
戻り値
boolean
継承元
Paginator.rateLimited定義場所
paginator.ts:132users
•get users(): any[]
戻り値
any[]
定義場所
paginator.ts:351メソッド
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:156next
▸ 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:211fetchPrevious
▸ fetchPrevious():Promise<void>
Fetch previous page (if supported)
戻り値
Promise<void>
継承元
Paginator.fetchPrevious定義場所
paginator.ts:225previous
▸ previous():Promise<Paginator<any>>
Get previous page as a new instance
戻り値
Promise<Paginator<any>>
継承元
Paginator.previous定義場所
paginator.ts:260fetchLast
▸ fetchLast(count): Promise<void>
Fetch up to a specified number of additional items
パラメーター
戻り値
Promise<void>
継承元
Paginator.fetchLast定義場所
paginator.ts:274reset
▸ 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>