Jerarquía
-
Paginator<any> ↳UserPaginator
Constructores
constructor
• new UserPaginator(fetchPage): UserPaginator
Creates a new paginator instance
Parámetros
Devuelve
UserPaginator
Heredado de
Paginator.constructorDefinido en
paginator.ts:90Accessors
items
•get items(): T[]
Get all fetched items
Devuelve
T[]
Heredado de
Paginator.itemsDefinido en
paginator.ts:97meta
•get meta(): any
Get current pagination metadata
Devuelve
any
Heredado de
Paginator.metaDefinido en
paginator.ts:104includes
•get includes(): undefined | Record<string, any>
Get current includes data
Devuelve
undefined | Record<string, any>
Heredado de
Paginator.includesDefinido en
paginator.ts:111errors
•get errors(): undefined | any[]
Get current errors
Devuelve
undefined | any[]
Heredado de
Paginator.errorsDefinido en
paginator.ts:118done
•get done(): boolean
Check if pagination is done
Devuelve
boolean
Heredado de
Paginator.doneDefinido en
paginator.ts:125rateLimited
•get rateLimited(): boolean
Check if rate limit was hit
Devuelve
boolean
Heredado de
Paginator.rateLimitedDefinido en
paginator.ts:132users
•get users(): any[]
Devuelve
any[]
Definido en
paginator.ts:351Mé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.
Devuelve
Promise<void>
Example
Throws
When the API request fails
Heredado de
Paginator.fetchNextDefinido en
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.
Devuelve
Promise<Paginator<any>>
New paginator instance for the next page
Example
Heredado de
Paginator.nextDefinido en
paginator.ts:211fetchPrevious
▸ fetchPrevious():Promise<void>
Fetch previous page (if supported)
Devuelve
Promise<void>
Heredado de
Paginator.fetchPreviousDefinido en
paginator.ts:225previous
▸ previous():Promise<Paginator<any>>
Get previous page as a new instance
Devuelve
Promise<Paginator<any>>
Heredado de
Paginator.previousDefinido en
paginator.ts:260fetchLast
▸ fetchLast(count): Promise<void>
Fetch up to a specified number of additional items
Parámetros
Devuelve
Promise<void>
Heredado de
Paginator.fetchLastDefinido en
paginator.ts:274reset
▸ reset():void
Reset paginator to initial state
Devuelve
void
Heredado de
Paginator.resetDefinido en
paginator.ts:288[iterator]
▸ [iterator]():Iterator<any, any, undefined>
Iterator for all fetched items
Devuelve
Iterator<any, any, undefined>
Heredado de
Paginator.[iterator]Definido en
paginator.ts:303[asyncIterator]
▸ [asyncIterator]():AsyncIterator<any, any, undefined>
Async iterator that fetches pages automatically
Devuelve
AsyncIterator<any, any, undefined>