sse-writer

Creates a text/event-stream stream as specified by the WD-eventsource W3C recommendation

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
sse-writer
3.0.44 years ago9 years agoMinified + gzip package size for sse-writer in KB

Readme

!Build Statustravis-imagetravis-url !Coveragecoveralls-imagecoveralls-url
node-sse-writer
Creates a text/event-stream stream as specified by the WD-eventsource W3C recommendation

Installation

npm install --save sse-writer

Usage

var SSE = require('sse-writer')
var sse = new SSE()

sse.retry('1 hour')
   .comment('comment this!')
   .event('Hello')
   .event('add', 'Floby')
   .event(8000, 'remove', 'Floby')
   .end()

sse.pipe(process.stdout)

results in the following stream
retry: 3600000

: comment this!
data: Hello

event: add
data: Floby

id: 8000
event: remove
data: Floby

Note that use can also provide a hash to .event()
sse.event({
  id: 8000,
  name: 'remove',
  data: 'Floby'
})

You can also use the raw stream.Writable interface (if you're piping from somewhere else for example)
var SSE = require('sse-writer');
var sse = SSE();

sse.write(SSE.Comment('comment this!'))
sse.write('Hello')
sse.write(['add', 'Floby'])
sse.write([8000, 'remove', 'Floby'])
sse.end();

Server example

You can use sse-writer in your web server as a regular middleware. Here with express:
var app = express()

app.use('/my/feed', function (req, res) {
  var sse = new SSE()
  sse.pipe(res)
  sse.comment('hey!')
     .event('add', 'Floby')

  setTimeout(function () {
    sse.event('some time later')
  }, 10000)
})

If you pipe to a http response object which has a setHeader(name, value) method, it will call response.setHeader('Content-Type', 'text/event-stream') for you.

Test

You can run the tests with npm test. You will need to know mochamocha-url

Contributing

Anyone is welcome to submit issues and pull requests

License

MIT
Copyright (c) 2019 Florent Jaby
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.