Buffer Dispatcher

With the wonders of asynchronous routines in JavaScript you can achieve more performant and smooth applications, but sometimes you just want to take it easy with all the racing and make sure all you async tasks are still asynchronous from the rest of your application but not from other tasks, for example a task that mutates a state in a particular way, you want to give it a chance of mutating it in all the ways it needs before another tasks mutates it from another part of you app.

Install

npm install @universal-packages/buffer-dispatcher

BufferDispatcher

It accumulates an array of entries and will call the dispatcher for every single one of them but awaiting before dispatching the next one.

import { BufferDispatcher } from '@universal-packages/buffer-dispatcher'

const messages = []

const dispatcher = async (payload) => {
  await sleep(payload.timeToWait)
  messages.push(payload.message)
}

const bufferDispatcher = new BufferDispatcher({ entryDispatcher: dispatcher, onError: 'continue' })

bufferDispatcher.append({ message: '1', timeToWait: 3000 })
bufferDispatcher.append({ message: '2', timeToWait: 2000 })
bufferDispatcher.append({ message: '3', timeToWait: 1000 })
bufferDispatcher.append({ message: '4', timeToWait: 0 })

await bufferDispatcher.await()

console.log(messages)
// > ['1', '2', '3', '4']

Constructor

(dispatcher: Function)

Instance methods

clear()

Stops the buffer dispatcher and clears the rest of the entries to not be despatched anymore.

stop()

Stops the buffer dispatcher and leaves intact the rest of the entries to be processed later.

continue()

In case the buffer dispatcher was stopped, it resumes the dispatching.

Getters

busy

Returns true or false depending on if the buffer dispatcher is currently dispatching.

Events

Buffer Dispatcher will emit the following events:

instance.on('*', (event) => console.log(event))
instance.on('push', (event) => console.log(event))
instance.on('resuming', (event) => console.log(event))
instance.on('stopping', (event) => console.log(event))
instance.on('stopped', (event) => console.log(event))
instance.on('idle', (event) => console.log(event))
instance.on('cleared', (event) => console.log(event))
instance.on('dispatching', (event) => console.log(event))
instance.on('dispatched', (event) => console.log(event))
instance.on('finished', (event) => console.log(event))
instance.on('error', (event) => console.log(event))

Typescript

This library is developed in TypeScript and shipped fully typed.

Contributing

The development of this library happens in the open on GitHub, and we are grateful to the community for contributing bugfixes and improvements. Read below to learn how you can take part in improving this library.

• Code of Conduct
• Contributing Guide

License

MIT licensed.