XStream

Transform binary stream

Import

import{ XStream }from"@ant-design/x";

Sourcecomponents/x-stream

Docs

Edit this page Changelog

When To Use

Transform SSE protocol ReadableStream to Record
Decode and read any protocol ReadableStream

Use

Common ReadableStream instances, such as await fetch(...).body, usage example:

import { XStream } from '@ant-design/x';

async function request() {
  const response = await fetch();
  // .....

  for await (const chunk of XStream({
    readableStream: response.body,
  })) {
    console.log(chunk);
  }
}

Examples

Default Protocol - SSE

SSE - https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events

The default transformStream in XStream is an SSE protocol stream transformer and is optional. The readableStream accepts a new ReadableStream(...) instance, such as await fetch(...).body

Custom Protocol

In this example, we will demonstrate parsing the SIP protocol, which is commonly used for P2P audio and video session initiation.

Pass in a transformStream stream transformer; this parameter accepts a new TransformStream(...) instance.

API

XStreamOptions

Property	Description	Type	Default	Version
readableStream	Readable stream of binary data	ReadableStream<'Uint8Array'>	-	-
transformStream	Support customizable transformStream to transform streams	TransformStream<string, T>	sseTransformStream	-