TypeScript XDK

El TypeScript XDK es la biblioteca cliente oficial para la X API v2. Seguridad de tipos completa, paginación automática y streaming basado en eventos.

Repositorio de GitHub

Código fuente, issues y releases.

Instalación

npm install @xdevplatform/xdk

Requiere Node.js 16+ y TypeScript 4.5+ (si usas TypeScript).

Guía rápida

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

Características clave

Característica	Descripción
Seguridad de tipos	Definiciones completas de TypeScript para todos los endpoints y parámetros
Autenticación	Bearer Token, OAuth 2.0 con PKCE y OAuth 1.0a
Paginación automática	Soporte de iteración asíncrona para endpoints paginados
Streaming	Streaming basado en eventos con reconexión automática
Cobertura completa de la API	Users, Posts, Lists, Bookmarks, Communities y más

Autenticación

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 comunes

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

Más información

Instalación

Gestores de paquetes, configuración de TypeScript y requisitos.

Autenticación

Guía detallada para todos los métodos de autenticación.

Paginación

Iteración asíncrona y respuestas paginadas.

Streaming

Streaming basado en eventos con reconexión.

Referencia de la API

Referencia completa del cliente, interfaces y tipos.

Para ver ejemplos de código, consulta el repositorio de ejemplos.

Repositorio de GitHub

​Instalación

​Guía rápida

​Características clave

​Autenticación

​Métodos comunes

​Más información

Instalación

Autenticación

Paginación

Streaming

Referencia de la API

Instalación

Guía rápida

Características clave

Autenticación

Métodos comunes

Más información