npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@server-sent-stream/web

v1.0.3

Published

Web Streams-compatible TransformStream for server-sent events

Downloads

25,639

Readme

@server-sent-stream/web

This package allows you to consume server-sent events through the Web Streams API. This lets you use them through e.g. the fetch API.

Usage

This package can be used as an ESM or CommonJS module:

import EventSourceStream from '@server-sent-stream/web';
const EventSourceStream = require('@server-sent-stream/web');

The EventSourceStream implements the TransformStream interface. It consumes a stream of Uint8Arrays (like the kind that the fetch API returns), and produces a stream of MessageEvents.

Here's an example of how it can be used with the fetch API:

// Fetch some URL that returns an event stream
const response = await fetch('https://example.com/events', {body: '...'});

// Pipe the response body into an EventSourceStream
const decoder = new EventSourceStream();
response.body.pipeThrough(decoder);

// Read from the EventSourceStream
const reader = decoder.readable.getReader();

while (true) {
    const {done, value} = await reader.read();
    if (done) break;

    // The value will be a `MessageEvent`.
    console.log(value);
    // MessageEvent {data: 'message data', lastEventId: '', …}
}

Limitations

There are a couple things that the EventSource API does and this doesn't:

  • Reconnection does not occur, and retry events are ignored.
  • The origin attribute of the emitted MessageEvents is not set.

Related packages

If you want a streaming interface for Node's stream API, see @server-sent-stream/node. For just the event stream parser, see @server-sent-stream/parser.