TypeScript XDK

TypeScript XDK は X API v2 向けの公式クライアントライブラリです。完全な型安全性、自動ページネーション、イベント駆動のストリーミングを提供します。

GitHub リポジトリ

ソースコード、Issue、リリース。

インストール

npm install @xdevplatform/xdk

Node.js 16 以上および TypeScript 4.5 以上 (TypeScript を使用する場合) が必要です。

クイックスタート

import { Client } from '@xdevplatform/xdk';

const client = new Client({ bearerToken: 'YOUR_BEARER_TOKEN' });

const userResponse = await client.users.getByUsername('XDevelopers');
console.log(userResponse.data?.username);

主な機能

機能	説明
型安全性	すべてのエンドポイントとパラメーターに対する完全な TypeScript 定義
認証	Bearer Token、PKCE 付き OAuth 2.0、および OAuth 1.0a
自動ページネーション	ページネーション対応エンドポイントで非同期イテレーションをサポート
ストリーミング	自動再接続を備えたイベント駆動型ストリーミング
完全な API カバレッジ	Users、Posts、Lists、Bookmarks、Communities ほか

認証

Bearer Token
OAuth 2.0
OAuth 1.0a

import { Client } from '@xdevplatform/xdk';

const client = new Client({ bearerToken: 'YOUR_BEARER_TOKEN' });

import { Client, OAuth2, generateCodeVerifier, generateCodeChallenge } from '@xdevplatform/xdk';

const oauth2 = new OAuth2({
  clientId: 'YOUR_CLIENT_ID',
  clientSecret: 'YOUR_CLIENT_SECRET',
  redirectUri: 'https://your-app.com/callback',
  scope: ['tweet.read', 'users.read', 'offline.access'],
});

const codeVerifier = generateCodeVerifier();
const codeChallenge = await generateCodeChallenge(codeVerifier);
oauth2.setPkceParameters(codeVerifier, codeChallenge);
const authUrl = await oauth2.getAuthorizationUrl('state');

const tokens = await oauth2.exchangeCode(authCode, codeVerifier);
const client = new Client({ accessToken: tokens.access_token });

import { Client, OAuth1 } from '@xdevplatform/xdk';

const oauth1 = new OAuth1({
  apiKey: 'YOUR_API_KEY',
  apiSecret: 'YOUR_API_SECRET',
  accessToken: 'YOUR_ACCESS_TOKEN',
  accessTokenSecret: 'YOUR_ACCESS_TOKEN_SECRET'
});

const client = new Client({ oauth1: oauth1 });

よく使うメソッド

カテゴリ	メソッド
Posts	`client.posts.search()`
Users	`client.users.getMe()`
Spaces	`client.spaces.findSpaceById()`
Lists	`client.lists.getList()`
DMs	`client.directMessages.lookup()`

さらに詳しく

インストール

パッケージマネージャー、TypeScript のセットアップ、必要条件。

認証

すべての認証方法の詳細ガイド。

ページネーション

非同期イテレーションとページネーションレスポンス。

ストリーミング

再接続付きイベント駆動型ストリーミング。

API リファレンス

クライアント、インターフェース、型の完全リファレンス。

コード例については samples リポジトリを参照してください。

GitHub リポジトリ

​インストール

​クイックスタート

​主な機能

​認証

​よく使うメソッド

​さらに詳しく

インストール

認証

ページネーション

ストリーミング

API リファレンス

インストール

クイックスタート

主な機能

認証

よく使うメソッド

さらに詳しく