Paginator

समृद्ध सुविधाओं वाला X API paginator यह क्लास X API के लिए व्यापक pagination समर्थन प्रदान करती है, जिसमें शामिल हैं:

for await...of लूप के साथ स्वचालित iteration
fetchNext() और 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

पदानुक्रम

Paginator ↳ PostPaginator ↳ UserPaginator ↳ EventPaginator

इम्प्लीमेंट्स

AsyncIterable<T>

कंस्ट्रक्टर्स

constructor

• new Paginator<T>(fetchPage): Paginator<T> एक नया Paginator instance बनाता है

type पैरामीटर

नाम
`T`

पैरामीटर

नाम	Type	विवरण
`fetchPage`	(`token?`: `string`) => `Promise`<`PaginatedResponse`<`T`>>	वह फ़ंक्शन जो pagination token दिए जाने पर डेटा का एक पेज फ़ेच करता है

रिटर्न

Paginator<T>

यहाँ परिभाषित है

paginator.ts:90

एक्सेसर

items

• get items(): T[] सभी फ़ेच किए गए आइटम लौटाता है

रिटर्न

T[]

यहाँ परिभाषित है

paginator.ts:97

includes

• get includes(): undefined | Record<string, any> वर्तमान includes डेटा प्राप्त करता है

रिटर्न

undefined | Record<string, any>

यहाँ परिभाषित है

paginator.ts:111

errors

• get errors(): undefined | any[] वर्तमान errors लौटाता है

रिटर्न

undefined | any[]

यहाँ परिभाषित है

paginator.ts:118

done

• get done(): boolean जाँचें कि pagination पूरा हुआ है या नहीं

रिटर्न

boolean

यहाँ परिभाषित है

paginator.ts:125

rateLimited

• get rateLimited(): boolean जांचें कि रेट लिमिट लागू हुई थी या नहीं

रिटर्न

boolean

यहाँ परिभाषित है

paginator.ts:132

मेथड्स

fetchNext

▸ 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); // दूसरा पृष्ठ
}

यहाँ परिभाषित है

paginator.ts:211

fetchPrevious

▸ fetchPrevious(): Promise<void> पिछला पेज फ़ेच करें (यदि समर्थित हो)

रिटर्न

Promise<void>

यहाँ परिभाषित है

paginator.ts:225

▸ previous(): Promise<Paginator<T>> पिछला पेज एक नए instance के रूप में प्राप्त करें

रिटर्न

Promise<Paginator<T>>

यहाँ परिभाषित है

paginator.ts:260

fetchLast

▸ fetchLast(count): Promise<void> निर्दिष्ट संख्या तक के अतिरिक्त आइटम प्राप्त करता है

पैरामीटर

नाम	Type
`count`	`number`

रिटर्न

Promise<void>

यहाँ परिभाषित है

paginator.ts:274

reset

▸ reset(): void paginator को उसकी प्रारंभिक स्थिति में रीसेट करता है

रिटर्न

void

यहाँ परिभाषित है

paginator.ts:288

[iterator]

▸ [iterator](): Iterator<T, any, undefined> सभी प्राप्त आइटम के लिए Iterator

रिटर्न

Iterator<T, any, undefined>

यहाँ परिभाषित है

paginator.ts:303

[asyncIterator]

▸ [asyncIterator](): AsyncIterator<T, any, undefined> ऐसा async iterator जो पेज अपने-आप फ़ेच करता है

रिटर्न

AsyncIterator<T, any, undefined>

का कार्यान्वयन

AsyncIterable.[asyncIterator]

यहाँ परिभाषित है

paginator.ts:312