package
This package extends backbone.sync method to support sending streams over socket.io using socket.io-streaming to backbone collections
npm install backbone.io-streamGitHub-flavored package documentation.
Across all versions.
Download trend unavailable.
Runtime metadata.
A drop-in replacement for Backbones Collection's Sync method that uses socket.io and socket.io-streaming to stream data to the collection from a fetch request.
Performing a fetch will return a jQuery promise that reports progress notifications as each new model is streamed from the server.
realtime
If you pass in the option realtime: true to the fetch method, the models will be added to the collection as they are streamed in from the server, otherwise it will wait until streaming has ended before adding the models to the collection.
merge
By default all new models will be merged into the collection, but that can be overridden by passing merge: false to the fetch method
Note:
If successful, the jQuery promise will return an array of objects that was returned from the server, unless the realtime option was set, in which case it will just return true
Node Tests
To run the tests navigate to project directory and type: grunt test or npm test.
Browser tests
To run browser tests, run command grunt testServer and that will start a local server. Go to localhost:8000 and the mocha test page will pop up showing the test results.
While this is certainly not ideal for browser tests, websocket support in headless browsers is greatly lacking currently.
There are two versions in the browser/dist folder.
To compile the browser files yourself (instead of using the ones in dist), run npm run-script compile or grunt default.
A very basic example of the server side can be found in the test/testServer.js file. A more real world use case would be piping a Mongoosejs QueryStream to the socket.io stream.
Estimated unpacked size across 36 packages.
9.2 MB
Includes dependencies.
7 direct · 6 outdated
~2.1.1
4.0.0
~1.1.2
1.6.1
~1.4.2
1.4.8
~1.2.1
4.8.4
~1.7.0
1.13.8
~1.0.33
4.8.0
~0.6.0
0.9.1