Skip to content

Latest commit

 

History

History
73 lines (62 loc) · 2.89 KB

README.md

File metadata and controls

73 lines (62 loc) · 2.89 KB
Raw

Bassoon.js

A simplified and optimized fork of oboejs. This package will allow you to easily and efficiently stream an array of JSON objects to your front-end.

Install w/ Express

First install the npm package.

npm install bassoon

Then serve the built script files up.

app.use('/bassoon', express.static('node_modules/bassoon/dist'));

And finally link the script in your HTML/view.

<script src="/bassoon/bassoon.min.js"></script>

Basic Usage

To stream an array of JSON objects subscribe to the data, end, and error events.

bassoon('/api/example/list')
  .on('data', (data) => { /* object received... */ }))
  .on('end', (evt) => { /* end of stream... */ })
  .on('error', (err) => { /* error occurred, stream stopped... */ });
  • The data event is fired every time an object is parsed from the response.
  • The end event is fired once the response is fully loaded.
  • The error event is fired if anything goes wrong.

Advanced Usage

A variety of arguments can be passed to bassoon as well.

bassoon({
  url: '/api/example/list',
  method: 'GET',
  withCredentials: false,
  chunkSize: 10,
})
  .on('data', (data) => { /* object received... */ }))
  .on('end', (evt) => { /* end of stream... */ })
  .on('error', (err) => { /* error occurred, stream stopped... */ });
  • url the URL of the JSON resource to be retrieved and processed incrementally.
  • method the HTTP verb to retrieve the resource with ("GET" by default)
  • withCredentials passed to xhr.withCredentials (false by default)
  • chunkSize Rather than triggering a data event for each object, group them into chunks and send each chunk as an array. chunkSize specifies the maximum size for each chunk, but chunks may be smaller than the chunkSize. (chunking disabled by default)
  • worker Offload the work to web worker. (default false)
  • workerPath Path to worker script file. (default "/bassoon/bassoon.worker.js")
  • verbose Enable verbose logging. (default false)

Web Worker

For better performance bassoon can stream data using the provided web worker script.

bassoon({ url: '/api/example/list', worker: true })
  .on('data', (data) => { /* object received... */ }))
  .on('end', (evt) => { /* end of stream... */ })
  .on('error', (err) => { /* error occurred, stream stopped... */ });

Related