https://github.com/rametta/meatball

🍝 Future based redux side effects
https://github.com/rametta/meatball

async epic epics future io redux

Last synced: 23 days ago
JSON representation

🍝 Future based redux side effects

• Host: GitHub
• URL: https://github.com/rametta/meatball
• Owner: rametta
• License: apache-2.0
• Created: 2018-11-23T13:26:11.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2018-12-05T18:35:38.000Z (about 6 years ago)
• Last Synced: 2024-12-07T08:02:32.555Z (27 days ago)
• Topics: async, epic, epics, future, io, redux
• Language: JavaScript
• Homepage:
• Size: 121 KB
• Stars: 7
• Watchers: 2
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![npm](https://img.shields.io/npm/v/meatball.svg)](http://npm.im/meatball)

[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](http://makeapullrequest.com)

[![Open Source Love](https://badges.frapsoft.com/os/v1/open-source.svg?v=103)](https://github.com/rametta/meatball/)

[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)

# 🍝 Meatball

> [Future](https://github.com/fluture-js/Fluture) based redux side effects

*Alternative to rxjs and redux-observable*

## Install

```sh

yarn add meatball

```

Meatball has a peer dependency on [fluture](https://github.com/fluture-js/Fluture)

```sh

yarn add fluture

```

## Usage examples

Listen to any redux action, perform side effect, return a new redux action to be fired

```js

// epics.js

import { searchRes, searchErr } from './reducer'

import { tryP, after } from 'fluture'

// Simple example

const simpleEpic = {

  type: 'SUBMIT_SEARCH', // listen for this action

  do: ({ payload }) => tryP(() => fetch(payload)) // fetch async data

    .map(res => res.json())

    .map(data => searchRes(data)) // redux action to save data

    .mapRej(e => searchErr(e)) // redux action for handling error

}

// Return multiple actions with an array

const multipleEpic = {

  type: 'SUBMIT_SEARCH', // listen for this action

  do: ({ payload }) => tryP(() => fetch(payload)) // fetch async data

    .map(res => res.json())

    .map(data => [searchRes(data), clearSidebar()]) // multiple actions

}

// Complex example

const complexEpic = {

  type: 'SUBMIT_SEARCH', // listen for this action

  latest: true, // Like rxjs switchMap, cancels previous action if not resolved

  do: ({ payload }) => after(200, payload) // delay fetching data for 200ms

    .chain(text => tryP(() => fetch(text)))

    .map(res => res.json())

    .map(data => [searchRes(data), clearSidebar()]) // multiple actions

    .mapRej(searchErr)

}

// Debounce example

const debounceEpic = {

  type: 'FILTER_SOMETHING', // listen for this action

  debounce: 1000, // debounce this action call for 1s

  do: ({ payload }) => tryP(() => fetch(payload)) // fetch async data

    .map(res => res.json())

    .map(data => filterRes(data)) // redux action to save data

    .mapRej(filterErr)) // redux action for handling error

}

export default [simpleEpic, multipleEpic, complexEpic, debounceEpic]

// index.js

import meatball from 'meatball'

import epics from './epics'

const store = createStore(

  reducers,

  applyMiddleware(meatball(epics))

)

```

[Real example](/example)