Documentation Index
Fetch the complete documentation index at: https://generaltranslation.mintlify.app/llms.txt
Use this file to discover all available pages before exploring further.
समृद्ध सुविधाओं वाला X API paginator
यह क्लास X API के लिए व्यापक pagination समर्थन प्रदान करती है, जिसमें शामिल हैं:
for await...of लूप के साथ स्वचालित iterationfetchNext() और fetchPrevious() के साथ मैनुअल पेज नियंत्रण- pagination टोकन और गिनतियों के लिए metadata access
- error handling और rate limit का पता लगाना
- आगे और पीछे, दोनों दिशाओं में pagination के लिए समर्थन
उदाहरण
// स्वचालित पुनरावृत्ति
const followers = await client.users.getFollowers('783214');
for await (const follower of followers) {
console.log(follower.username);
}
// मैन्युअल नियंत्रण
const followers = await client.users.getFollowers('783214');
await followers.fetchNext();
console.log(followers.items.length); // फ़ॉलोअर्स की संख्या
console.log(followers.meta.nextToken); // अगले पेज का टोकन
// स्थिति जाँचें
if (!followers.done) {
await followers.fetchNext();
}
Type पैरामीटर
| नाम | विवरण |
|---|
T | पेजिनेट की जा रही आइटमों का type |
T>(fetchPage): Paginator<T>
एक नया Paginator instance बनाता है
| नाम | Type | विवरण |
|---|
fetchPage | (token?: string) => Promise<PaginatedResponse<T>> | वह फ़ंक्शन जो pagination token दिए जाने पर डेटा का एक पेज फ़ेच करता है |
Paginator<T>
paginator.ts:90
• get items(): T[]
सभी फ़ेच किए गए आइटम लौटाता है
T[]
paginator.ts:97
• get meta(): any
वर्तमान pagination मेटाडेटा लौटाता है
any
paginator.ts:104
• get includes(): undefined | Record<string, any>
वर्तमान includes डेटा प्राप्त करता है
undefined | Record<string, any>
paginator.ts:111
• get errors(): undefined | any[]
वर्तमान errors लौटाता है
undefined | any[]
paginator.ts:118
• get done(): boolean
जाँचें कि pagination पूरा हुआ है या नहीं
boolean
paginator.ts:125
• get rateLimited(): boolean
जांचें कि रेट लिमिट लागू हुई थी या नहीं
boolean
paginator.ts:132
▸ fetchNext(): Promise<void>
अगला पेज फ़ेच करें और आइटम मौजूदा instance में जोड़ें
यह method डेटा का अगला पेज फ़ेच करती है और आइटम को मौजूदा
paginator instance में जोड़ती है। यह pagination की स्थिति और metadata को अपडेट करती है।
Promise<void>
उदाहरण
const followers = await client.users.getFollowers('783214');
await followers.fetchNext(); // पहला पेज प्राप्त करें
console.log(followers.items.length); // फ़ॉलोअर्स की संख्या
if (!followers.done) {
await followers.fetchNext(); // दूसरा पेज प्राप्त करें
console.log(followers.items.length); // सभी पेजों में कुल फ़ॉलोअर्स
}
Throws
जब API अनुरोध विफल हो जाए
paginator.ts:156
▸ next(): Promise<Paginator<T>>
अगला पेज नए instance के रूप में प्राप्त करें
यह method नया paginator instance बनाता है, जो अगले पेज से शुरू होता है
और वर्तमान paginator की स्थिति को प्रभावित नहीं करता।
Promise<Paginator<T>>
अगले पेज के लिए नया Paginator इंस्टेंस
Example
const followers = await client.users.getFollowers('783214');
await followers.fetchNext(); // पहला पृष्ठ प्राप्त करें
if (!followers.done) {
const nextPage = await followers.next(); // नए इंस्टेंस के रूप में अगला पृष्ठ प्राप्त करें
console.log(followers.items.length); // अभी भी पहला पृष्ठ
console.log(nextPage.items.length); // दूसरा पृष्ठ
}
▸ fetchPrevious(): Promise<void>
पिछला पेज फ़ेच करें (यदि समर्थित हो)
Promise<void>
paginator.ts:225
▸ previous(): Promise<Paginator<T>>
पिछला पेज एक नए instance के रूप में प्राप्त करें
Promise<Paginator<T>>
paginator.ts:260
▸ fetchLast(count): Promise<void>
निर्दिष्ट संख्या तक के अतिरिक्त आइटम प्राप्त करता है
Promise<void>
paginator.ts:274
▸ reset(): void
paginator को उसकी प्रारंभिक स्थिति में रीसेट करता है
void
paginator.ts:288
▸ [iterator](): Iterator<T, any, undefined>
सभी प्राप्त आइटम के लिए Iterator
Iterator<T, any, undefined>
paginator.ts:303
▸ [asyncIterator](): AsyncIterator<T, any, undefined>
ऐसा async iterator जो पेज अपने-आप फ़ेच करता है
AsyncIterator<T, any, undefined>
AsyncIterable.[asyncIterator]
paginator.ts:312
