# redux-ship-devtools

> > Side effects inspector for [Redux Ship](https://github.com/clarus/redux-ship).

Latest version **0.1.4** (published 2017-04-22) · MIT license · 0 weekly downloads

## Install

```sh
npm install redux-ship-devtools
pnpm add redux-ship-devtools
yarn add redux-ship-devtools
bun add redux-ship-devtools
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.4 |
| Published | 2017-04-22 |
| First published | 2016-11-28 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 5 |
| Author | Guillaume Claret |
| Maintainers | clarus |

## Links

- npm: https://www.npmjs.com/package/redux-ship-devtools
- Repository: https://github.com/clarus/redux-ship-devtools
- Issues: https://github.com/clarus/redux-ship-devtools/issues
- npm.io page: https://npm.io/package/redux-ship-devtools

## Dependencies (1)

- [redux-ship](https://npm.io/package/redux-ship.md) ^0.1.4

## Recent versions

- 0.1.4 (latest) — 2017-04-22
- 0.1.3 — 2016-12-07
- 0.1.2 — 2016-12-03
- 0.1.1 — 2016-11-28
- 0.1.0 — 2016-11-28

## README

# Redux Ship DevTools
> Side effects inspector for [Redux Ship](https://github.com/clarus/redux-ship).

[![Screenshot](https://raw.githubusercontent.com/clarus/redux-ship-devtools/screenshots/animation.gif)](https://clarus.github.io/redux-ship-devtools/)

The Redux Ship DevTools show a 2D view of the side effects of a [Redux Ship](https://github.com/clarus/redux-ship) program:
* vertically: sequential side effects;
* horizontally: concurrent side effects.

Go to the [demo page](https://clarus.github.io/redux-ship-devtools/) to see a live example :rocket:.

## Install
Download the extension on the [Chrome Web Store](https://chrome.google.com/webstore/detail/redux-ship-devtools/kbcgcifbcgamdlgdahbfangmfiofpmni) (other platforms are not supported yet).

## Usage
To enable the Redux Ship DevTools extension in a project you need to connect it to your code. For that, install the devtools package:
```
npm install redux-ship-devtools
```
and wrap your controller:
```js
import * as ShipDevTools from 'redux-ship-devtools';

function dispatch(action: Controller.Action): void {
  Ship.run(Effect.run, store, ShipDevTools.inspect(Controller.control)(action));
}
```

## API
### `inspect`
```js
<Action, Effect, Commit, State, A>(
  control: (action: Action) => Ship<Effect, Commit, State, A>
) => (action: Action) => Ship<Effect, Commit, State, A>
```

Returns a function behaving as `control` but sending snapshots to the Redux Ship DevTools.

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