Redux-root-saga NPM

About

Redux Root Saga provides an easy way to quickly run multiple sagas concurrently in a tested and widely used way.

This package is originally based on the root saga pattern from the official documentation and therefore an easy way to get the described behavior without copy-pasting it into every new project.

See #-features for an overview of all available options and the extended functionality.

⚙️ Installation

Latest stable release

npm install --save redux-root-saga

yarn add redux-root-saga

Latest Release Candidate

npm install --save redux-root-saga@next

yarn add redux-root-saga@next

⚡️ Getting Started

import { createStore, applyMiddleware } from 'redux';
import createSagaMiddleware from '@redux-saga/core';
import createRootSaga from 'redux-root-saga';

function* saga1() {
    /*...*/
}
function* saga2() {
    /*...*/
}

// Option 1: Execute all specified sagas concurrently with default options.
const rootSaga = createRootSaga([saga1, saga2]);

// Option 2: Start all sagas with (partly) customized default options.
const rootSaga = createRootSaga([saga1, saga2], {
    maxRetries: 3,
    errorHandler: (error, saga, options) => console.err(
        `Error in saga ${saga.name} with options ${options}: ${error}`);
});

// Option 3: Start all sagas with (partly) customized default options
// and use specific custom options only for saga1.
// All other options of saga1 fallback to the (customized) default ones.
const rootSaga = createRootSaga([[saga1, { maxRetries: Infinity }], saga2], {
    maxRetries: 3,
    onError: (error, saga, options) => console.error(
        `Error in saga ${saga.name} with options ${options}: ${error}`),
});

const sagaMiddleware = createSagaMiddleware();
const store = createStore(reducer, applyMiddleware(sagaMiddleware));
sagaMiddleware.run(rootSaga);