TypeScript XDK

O TypeScript XDK é a biblioteca cliente oficial para a X API v2. Type safety completo, paginação automática e streaming orientado a eventos.

Repositório no GitHub

Código-fonte, issues e releases.

Instalação

npm install @xdevplatform/xdk

Requer Node.js 16+ e TypeScript 4.5+ (se estiver usando TypeScript).

Início rápido

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);

Principais recursos

Recurso	Descrição
Type safety	Definições TypeScript completas para todos os endpoints e parâmetros
Autenticação	Bearer Token, OAuth 2.0 com PKCE e OAuth 1.0a
Paginação automática	Suporte a iteração assíncrona para endpoints paginados
Streaming	Streaming orientado a eventos com reconexão automática
Cobertura completa da API	Users, Posts, Lists, Bookmarks, Communities e muito mais

Autenticação

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 });

Métodos comuns

Categoria	Método
Posts	`client.posts.search()`
Users	`client.users.getMe()`
Spaces	`client.spaces.findSpaceById()`
Lists	`client.lists.getList()`
DMs	`client.directMessages.lookup()`

Saiba mais

Instalação

Gerenciadores de pacote, configuração do TypeScript e requisitos.

Autenticação

Guia detalhado para todos os métodos de autenticação.

Paginação

Iteração assíncrona e respostas paginadas.

Streaming

Streaming orientado a eventos com reconexão.

Referência da API

Referência completa de clientes, interfaces e tipos.

Para ver exemplos de código, confira o repositório de samples.

Repositório no GitHub

​Instalação

​Início rápido

​Principais recursos

​Autenticação

​Métodos comuns

​Saiba mais

Instalação

Autenticação

Paginação

Streaming

Referência da API

Instalação

Início rápido

Principais recursos

Autenticação

Métodos comuns

Saiba mais