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

sse-stringify

v1.0.0

Published

Marshalling Javascript data into Server-Sent Events (sse) text/event-stream format

Downloads

52

Readme

sse-stringify

Marshalling Javascript data into Server-Sent Events (sse) text/event-stream format

Installing

npm install sse-stringify

Basic usage

import { sseStringify } from 'sse-stringify';

sseStringify({
  id: '0',
  data: JSON.stringify({}),
  event: 'my-event',
});
// 'id: 0\nevent: my-event\ndata: {}\n\n'

sseStringify({ retry: 1000 });
// 'retry: 1000\n\n'

sseStringify({ comment: 'OK' });
// ': OK\n\n'

Data can be a multiline string

It can be useful to send some lines of csv or ndjson within the same event/message.

const prettyJSON = JSON.stringify({ a: 1, o: { nested: [] } }, null, 2);
sseStringify({ data: prettyJSON });
/*
'data: {\n' +
'data:   "a": 1,\n' +
'data:   "o": {\n' +
'data:     "nested": []\n' +
'data:   }\n' +
'data: }\n' +
'\n'
*/

Using with iterables and streams

We can pass false as the second parameter to disable the newline at the end and thus call the function several times but send only 1 event with the result.

This allows better mapping between the JS data structure and the text/event-stream format or use this function with iterables and streams.

let event = '';

const arr = [
  { event: 'my-event' },
  { data: 'csv or ndjson line' },
  { data: 'csv or ndjson line' },
  { id: '0' },
];

arr.forEach((value, index, array) => {
  if (index === array.length - 1) {
    // last item should have a newline at the end
    event += sseStringify(value);
  } else {
    event += sseStringify(value, false);
  }
});

/* or

arr.forEach((value, index, array) => {
  event += sseStringify(value, false);
});

event += '\n';
*/

console.log(event);
// 'event: my-event\ndata: csv or ndjson line\ndata: csv or ndjson line\nid: 0\n\n'

License

MIT licensed.