पदानुक्रम
-
Paginator<any> ↳EventPaginator
कंस्ट्रक्टर
constructor
fetchPage): EventPaginator
एक नया paginator instance तैयार करता है
पैरामीटर
| नाम | Type | विवरण |
|---|---|---|
fetchPage | (token?: string) => Promise<PaginatedResponse<any>> | वह फ़ंक्शन जो pagination token दिए जाने पर डेटा का एक पेज फ़ेच करता है |
रिटर्न
EventPaginator
यहाँ से इनहेरिट किया गया
यहाँ परिभाषित
एक्सेसर
items
get items(): T[]
सभी फ़ेच किए गए आइटम लौटाता है
रिटर्न
T[]
से इनहेरिट किया गया
Paginator.itemsयहाँ परिभाषित
meta
get meta(): any
वर्तमान पेजिनेशन मेटाडेटा प्राप्त करता है
रिटर्न
any
से इनहेरिट किया गया
Paginator.metaयहाँ परिभाषित
includes
get includes(): undefined | Record<string, any>
वर्तमान includes डेटा प्राप्त करता है
रिटर्न
undefined | Record<string, any>
से इनहेरिट किया गया
Paginator.includesयहाँ परिभाषित
errors
get errors(): undefined | any[]
वर्तमान errors लौटाता है
रिटर्न
undefined | any[]
से इनहेरिट किया गया
Paginator.errorsयहाँ परिभाषित
done
get done(): boolean
यह जाँचता है कि पेजिनेशन पूरा हो गया है या नहीं
रिटर्न
boolean
से इनहेरिट किया गया
Paginator.doneयहाँ परिभाषित
rateLimited
get rateLimited(): boolean
जांचें कि क्या rate limit पार हो गई थी
रिटर्न
boolean
से इनहेरिट किया गया
Paginator.rateLimitedयहाँ परिभाषित
events
get events(): any[]
रिटर्न
any[]
यहाँ परिभाषित
मेथड्स
fetchNext
Promise<void>
अगला पेज फ़ेच करें और आइटम को मौजूदा instance में जोड़ें
यह method डेटा का अगला पेज फ़ेच करता है और आइटम को मौजूदा
paginator instance में जोड़ता है। यह pagination state और metadata को अपडेट करता है।
रिटर्न
Promise<void>
उदाहरण
Throws
जब API अनुरोध विफल हो जाए
से इनहेरिट किया गया
Paginator.fetchNextयहाँ परिभाषित
next
Promise<Paginator<any>>
अगला पेज एक नए instance के रूप में प्राप्त करें
यह method एक नया paginator instance बनाता है, जो अगले पेज से शुरू होता है
और वर्तमान paginator की स्थिति को प्रभावित नहीं करता।
रिटर्न
Promise<Paginator<any>>
अगले पेज के लिए नया Paginator इंस्टेंस
उदाहरण
से इनहेरिट किया गया
Paginator.nextयहाँ परिभाषित
fetchPrevious
Promise<void>
पिछला पेज प्राप्त करता है (यदि समर्थित हो)
रिटर्न
Promise<void>
से इनहेरिट किया गया
Paginator.fetchPreviousयहाँ परिभाषित
previous
Promise<Paginator<any>>
पिछला पेज एक नए instance के रूप में प्राप्त करें
रिटर्न
Promise<Paginator<any>>
से इनहेरिट किया गया
Paginator.previousयहाँ परिभाषित
fetchLast
count): Promise<void>
निर्दिष्ट संख्या तक अतिरिक्त आइटम फ़ेच करता है
पैरामीटर
| नाम | Type |
|---|---|
count | number |
लौटाता है
Promise<void>
से इनहेरिट किया गया
Paginator.fetchLastयहाँ परिभाषित
reset
void
पेजिनेटर को उसकी प्रारंभिक स्थिति में रीसेट करता है
रिटर्न
void
से इनहेरिट किया गया
Paginator.resetयहाँ परिभाषित
[iterator]
Iterator<any, any, undefined>
सभी प्राप्त किए गए आइटमों के लिए Iterator
रिटर्न
Iterator<any, any, undefined>
से इनहेरिट किया गया
Paginator.[iterator]यहाँ परिभाषित
[asyncIterator]
AsyncIterator<any, any, undefined>
ऐसा Async iterator जो पेजों को स्वचालित रूप से फ़ेच करता है
रिटर्न
AsyncIterator<any, any, undefined>