Saltar al contenido principal

Documentation Index

Fetch the complete documentation index at: https://generaltranslation.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

El SDK de TypeScript proporciona capacidades de streaming en tiempo real para flujos de datos en directo.

Streaming básico

Conéctate a un muestreo en tiempo real de publicaciones:
import { Client } from '@xdevplatform/xdk';

const client: Client = new Client({ bearerToken: 'your-bearer-token' });

// 1% de publicaciones públicas muestreadas
const stream = await client.stream.postsSample({
  tweetFields: ['id','text','created_at'],
  expansions: ['author_id'],
  userFields: ['id','username','name']
});

// Escucha los eventos
stream.on('data', (event) => {
  // event es la línea JSON ya analizada (data/includes/matching_rules)
  console.log('New data:', event);
});

stream.on('error', (e) => console.error('Stream error:', e));
stream.on('close', () => console.log('Stream closed'));

Iteración asíncrona

Consume el stream usando iteración asíncrona:
const stream = await client.stream.postsSample();
for await (const event of stream) {
  // Cada evento es una línea JSON parseada (data/includes/matching_rules)
  console.log(event);
}

Gestión del stream

Controla el ciclo de vida desde el stream orientado a eventos:
// Cerrar el stream
stream.close();

// Reconexión automática (si está habilitada en tu wrapper)
// El EventDrivenStream predeterminado expone hooks básicos de reconexión

Manejo de errores

Gestiona los errores de streaming y las reconexiones:
stream.on('error', (event) => {
  const err = event.error || event;
  console.error('Stream error:', err);
});

stream.on('keepAlive', () => {
  // evento heartbeat
});
Para ver ejemplos de código detallados usando el XDK para JavaScript/TypeScript, consulta nuestro repositorio de ejemplos de código en GitHub.