基本的なページネーション
quick-start.ts
import { Client, UserPaginator, PaginatedResponse, Schemas } from '@xdevplatform/xdk';
const client: Client = new Client({ bearerToken: 'your-bearer-token' });
// Wrap any list endpoint with proper typing
const followers: UserPaginator = new UserPaginator(
async (token?: string): Promise<PaginatedResponse<Schemas.User>> => {
const res = await client.users.getFollowers('<userId>', {
maxResults: 100,
paginationToken: token,
userFields: ['id','name','username'],
});
return {
data: res.data ?? [],
meta: res.meta,
includes: res.includes,
errors: res.errors
};
}
);
import { Client } from '@xdevplatform/xdk';
import { UserPaginator } from '@xdevplatform/xdk';
const client = new Client({ bearerToken: 'your-bearer-token' });
const followers = new UserPaginator(async (token) => {
const res = await client.users.getFollowers('<userId>', {
maxResults: 100,
paginationToken: token,
userFields: ['id','name','username'],
});
return { data: res.data ?? [], meta: res.meta, includes: res.includes, errors: res.errors };
});
手動でのページング
import { UserPaginator, Schemas } from '@xdevplatform/xdk';
await followers.fetchNext(); // first page
while (!followers.done) {
await followers.fetchNext(); // subsequent pages
}
const userCount: number = followers.users.length; // all fetched users
const firstUser: Schemas.User | undefined = followers.users[0];
const nextToken: string | undefined = followers.meta?.nextToken;
await followers.fetchNext();
while (!followers.done) await followers.fetchNext();
console.log(followers.items.length);
非同期イテレーション
import { Schemas } from '@xdevplatform/xdk';
for await (const user of followers) {
const typedUser: Schemas.User = user;
console.log(typedUser.username); // fully typed access
}
for await (const user of followers) {
console.log(user.username);
}
次のページを新しいインスタンスとして取得
import { UserPaginator } from '@xdevplatform/xdk';
await followers.fetchNext();
if (!followers.done) {
const page2: UserPaginator = await followers.next(); // independent paginator starting at next page
await page2.fetchNext();
console.log(page2.users.length); // items from second page
}
await followers.fetchNext();
if (!followers.done) {
const page2 = await followers.next();
await page2.fetchNext();
}
エラーハンドリングとレート制限
import { UserPaginator, Schemas } from '@xdevplatform/xdk';
try {
for await (const item of followers) {
const user: Schemas.User = item;
// process user...
}
} catch (err: unknown) {
if (followers.rateLimited) {
console.error('Rate limited, backoff required');
// backoff / retry later
} else {
console.error('Pagination error:', err);
throw err;
}
}
try {
for await (const item of followers) {
// ...
}
} catch (err) {
if (followers.rateLimited) {
// backoff / retry later
} else {
throw err;
}
}
JavaScript/TypeScript XDK を使った詳細なコードサンプルは、コードサンプル GitHub リポジトリを参照してください。