sse-reader v1.2.2

node-sse-reader

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

Installation

npm install --save sse-reader

Usage

var Reader = require('sse-reader');
var reader = Reader();
source.pipe(reader);

The following stream

: comment this!
data: Hello

event: add
data: Floby

id: 8000
event: remove
data: Floby

results in the following events being triggered

'event' -> ('Hello')
'data'  -> ({data: 'Hello'})
'event' -> ('Floby', 'add')
'event:add'   -> ('Floby')
'data'  -> ({name: 'add', data: 'Floby'})
'event' -> ('Floby', 'remove', '8000')
'event:remove'-> ('Floby')
'id'    -> ('8000')
'data'  -> ({id: '8000', name: 'remove', data: 'Floby'})
'end'   -> ()

The data event of course come from the basic readable stream interface which means you can also call .read() and pipe().

Test

You can run the tests with npm test. You will need to know mocha

Contributing

Anyone is welcome to submit issues and pull requests

License

MIT

Copyright (c) 2015 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.