# @edy/redux-api-middleware

> Redux API Middleware

Latest version **1.0.3** (published 2017-08-10) · MIT license · 0 weekly downloads

## Install

```sh
npm install @edy/redux-api-middleware
pnpm add @edy/redux-api-middleware
yarn add @edy/redux-api-middleware
bun add @edy/redux-api-middleware
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.3 |
| Published | 2017-08-10 |
| First published | 2017-08-08 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Eduard Baun |
| Maintainers | edy |
| Keywords | redux, api, middleware |

## Links

- npm: https://www.npmjs.com/package/@edy/redux-api-middleware
- Repository: https://github.com/edy/redux-api-middleware
- Homepage: https://github.com/edy/redux-api-middleware#readme
- Issues: https://github.com/edy/redux-api-middleware/issues
- npm.io page: https://npm.io/package/@edy/redux-api-middleware

## Alternatives

- [@sindresorhus/slugify](https://npm.io/package/@sindresorhus/slugify.md) — 3.7M weekly downloads
- [solid-js](https://npm.io/package/solid-js.md) — 2.7M weekly downloads
- [expo-glass-effect](https://npm.io/package/expo-glass-effect.md) — 2.5M weekly downloads
- [nanoassert](https://npm.io/package/nanoassert.md) — 780.8K weekly downloads
- [@ffmpeg/ffmpeg](https://npm.io/package/@ffmpeg/ffmpeg.md) — 529.5K weekly downloads

## Recent versions

- 1.0.3 (latest) — 2017-08-10
- 1.0.2 — 2017-08-09
- 1.0.1 — 2017-08-08

## README

# Redux API Middleware [![npm](https://img.shields.io/npm/v/@edy/redux-api-middleware.svg?maxAge=2592000&style=flat-square)](https://www.npmjs.com/package/@edy/redux-api-middleware) [![Build Status](https://travis-ci.org/edy/redux-api-middleware.svg?branch=master)](https://travis-ci.org/edy/redux-api-middleware)

A simple middleware based on the one from the [Redux Docs](http://redux.js.org/docs/recipes/ReducingBoilerplate.html).

## Installation
```
  npm install @edy/redux-api-middleware
```

## Usage
Please see [Middleware Docs](http://redux.js.org/docs/advanced/Middleware.html) on how to add middleware to redux. This is how i use it:

```js
import { createStore, applyMiddleware } from 'redux';
import apiMiddleware from '@edy/redux-api-middleware';
import rootReducer from './reducers/index';

const store = createStore(
  rootReducer,
  applyMiddleware(apiMiddleware)
);
```

### Example 1 (easy)
Action:
```js
export function loadUsers () {
	return {
		types: [START, SUCCESS, ERROR],
		callAPI: () => fetch('/users'),
	};
};
```

Then somewhere in your component:
```js
dispatch(loadUsers());
```

Reducer:
```js
switch (action.type) {
	case START:
		return {
			...state,
			isLoading: true
		};

	case SUCCESS:
		return {
			...state,
			users: action.response,
			isLoading: false
		};

	case ERROR:
		return {
			...state,
			isLoading: false,
			error: action.error
		};
	default:
		return state;
}
```


### Example 2 (not so easy)
Action:
```js
export function setToken (newToken) {
	return {
		types: [START, SUCCESS, ERROR],
		payload: {
			token: newToken
		},
		shouldCallAPI: (state) => {
			const { token, tokenSentToServer, tokenDidInvalidate, tokenSentToServerOn, tokenIsUpdating } = state.settings;
			const lastUpdated = new Date() - new Date(tokenSentToServerOn);

			if (token !== newToken) {
				return true;
			} else if (tokenIsUpdating) {
				return false;
			} else if (lastUpdated > 86400000) { // 86400s = 24h
				return true;
			} else if (!tokenSentToServer) {
				return true;
			}

			return tokenDidInvalidate;
		},
		callAPI: ({ dispatch, getState, payload}) => api.setToken(newToken).then((data) => newToken),
		onStart: ({ dispatch, getState, payload}) => {
			// do something before the api is called
		},
		onSuccess: ({ dispatch, getState, payload, response }) => {
			// do something after api was called
		},
		onError: ({ dispatch, getState, payload, error }) => {
			// do something after an error occured, maybe display a notification
		},
	};
};
```

Then somewhere in your component:
```js
dispatch(setToken(1234567890));
```

Reducer:
```js
switch (action.type) {
	case START:
		return {
			...state,
			tokenSentToServer: false,
			tokenIsUpdating: true
		};

	case SUCCESS:
		return {
			...state,
			token: action.payload.token,
			tokenSentToServer: true,
			tokenDidInvalidate: false,
			tokenIsUpdating: false
		};

	case ERROR:
		return {
			...state,
			tokenSentToServer: false,
			tokenIsUpdating: false
		};
	default:
		return state;
}
```

---
_Source: https://npm.io/package/@edy/redux-api-middleware · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
