es-sse

A Server-Sent Events (SSE) parsing library built with modern design patterns

Features

• 🔄 Modern SSE parsing implementation
• 🛡️ TypeScript support
• 🧪 Comprehensive test coverage
• 🚀 Zero dependencies
• 📦 Lightweight and fast

Installation

1# npm
2npm install es-sse
3
4# pnpm
5pnpm add es-sse
6
7# yarn
8yarn add es-sse

Usage

1import { parseSSE } from 'es-sse';
2
3// Parse a single event
4const eventChunk = 'event: test-event\ndata: test-data\n\n';
5const result = parseSSE(eventChunk);
6
7// Result will be:
8// {
9//   data: [{
10//     event: 'test-event',
11//     data: 'test-data'
12//   }],
13//   restString: ''
14// }
15
16// Handle incomplete events with restString
17let buffer = '';
18const chunks = [
19  'event: first\ndata: first-data\n\nevent: second\ndata: second-data\n\nevent: third\ndata: third',
20  '-data\n\n'
21];
22
23// Process chunks
24for (const chunk of chunks) {
25  buffer += chunk;
26  const result = parseSSE(buffer);
27  
28  // Process complete events
29  for (const event of result.data) {
30    console.log('Received event:', event);
31  }
32  
33  // Keep the rest for next iteration
34  buffer = result.restString;
35}
36
37// Final buffer state
38console.log('Remaining buffer:', buffer); // Should be empty