Redux Eggs Saga Extension

Redux Eggs extension that brings dynamic sagas to your Redux store.

Contents:

• Installation
• Usage
• Glossary
• Examples

Installation:

If you are using Yarn, run

yarn add @redux-eggs/core @redux-eggs/saga-extension

If you are using NPM, run

npm install --save @redux-eggs/core @redux-eggs/saga-extension

⚠️ Minimum supported versions of peer dependencies:

• redux-saga 1.1.0 and newer

Usage

Create your store:

import { createStore } from '@redux-eggs/redux-toolkit'
import { getSagaExtension } from '@redux-eggs/saga-extension'

export const store = createStore({ extensions: [getSagaExtension()] })

Add sagas to your eggs:

// my-egg-with-sagas.js
export const getMyEggWithSagas = () => {
  return {
    id: 'my-egg-with-sagas',
    sagas: [mySaga1, mySaga2],
    // ...
  }
}

// my-another-egg-with-sagas.js
export const getMyAnotherEggWithSagas = () => {
  return {
    id: 'my-another-egg-with-sagas',
    sagas: [mySaga3, mySaga4],
    // ...
  }
}

Your sagas will run automatically, just add them to your store:

import { getMyEggWithSagas } from '../eggs//my-egg-with-sagas'
import { getMyAnotherEggWithSagas } from '../eggs/my-another-egg-with-sagas'

// Somewhere in your application
store.addEggs([getMyEggWithSagas(), getMyAnotherEggWithSagas()])

Remove your sagas from store, they will be cancelled automatically:

// Somewhere in your application
const remove = store.addEggs([
  /* array of `eggs` */
])

// ...later
remove()