Feedback: Streaming

[JasperV]

• Open page

Feedback

I am looking for an example of streaming that does Server Sent Event. I would love to mock those in my current project.

[kettanaito]

Hi, @JasperV 👋

You can find a Server Sent Events example in here: https://alexocallaghan.com/mock-sse-with-msw.

For posterity, here's the usage example:

import { http, HttpResponse } from "msw";

const encoder = new TextEncoder();

const handler = http.get('http://example.com/stream', () => {
  const stream = new ReadableStream({
    start(controller) {
      controller.enqueue(
        encoder(
          `event:some-event\ndata:some data\n\n`
        )
      );
      controller.close();
    },
  });

  return new HttpResponse(stream, {
    headers: {
      "Content-Type": "text/event-stream",
    }.
  });
});

I am also working on the first-class support for SSE events in mswjs/msw#2299. It's already in a usable state. Let me know if you'd like to give it a try, I can do a preview release for you to install it in your project.

[kettanaito]

I won't add this example because it's too low level. I would rather document the new SSE support in MSW once it's out. For now, utilizing ReadableStream and sending SSE is considered implied knowledge.

[JasperV]

Hello @kettanaito,

I got it working with this example, thanks!

Sure, if it can be made easier, I would like to try that out. Does it come with a manual of some sort?

[kettanaito]

@JasperV I will document it in the upcoming weeks and publish a preview release. Just subscribe to the updates on the repo I linked and you won't miss it.