@vmw/queue-for-redux-saga

Run Redux-Sagas without a "rootSaga". Kill boilerplate. Split code.

Usage no npm install needed!

<script type="module">
  import vmwQueueForReduxSaga from 'https://cdn.skypack.dev/@vmw/queue-for-redux-saga';
</script>

README

Queue for Redux-Saga

build status Contributor Covenant

Run Redux-Sagas without a "rootSaga". Kill boilerplate. Split code.

Install

npm install --save @vmw/queue-for-redux-saga

Purpose

Queue for Redux-Saga eliminates "rootSaga" boilerplate code. Saga Watchers no longer need to be imported and run by a "rootSaga".

Queue for Redux-Saga promotes code splitting. Saga Watchers can now be loaded "as needed", rather than up front.

What's Included

Queue for Redux-Saga includes:

  • configureSagaStore(): Function that wraps "Redux ToolKit: configureStore".
  • runSaga(): Function that runs a Saga as soon as the Redux Store is configured.
  • setSagaRunner(): Function to be called after configuring the Redux Store.
    Note: Not required if using configureSagaStore.
  • getQueuedSagas(): Utility for use in Unit Tests.
  • clearQueuedSagas(): Utility for use in Unit Tests.

Documentation

The Queue for Redux-Saga docs are available at https://vmware.github.io/queue-for-redux-saga**.

Contributing

The queue-for-redux-saga project team welcomes contributions from the community. Before you start working with queue-for-redux-saga, please read our Developer Certificate of Origin. All contributions to this repository must be signed as described on that page. Your signature certifies that you wrote the patch or have the right to pass it on as an open-source patch. For more detailed information, refer to CONTRIBUTING.md.

License

Open source licensed as MIT.