https://github.com/clarus/redux-ship-devtools
Redux Ship DevTools
https://github.com/clarus/redux-ship-devtools
Last synced: 4 months ago
JSON representation
Redux Ship DevTools
- Host: GitHub
- URL: https://github.com/clarus/redux-ship-devtools
- Owner: clarus
- License: mit
- Created: 2016-11-13T09:40:15.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2020-09-24T11:55:36.000Z (over 4 years ago)
- Last Synced: 2025-01-31T09:01:38.428Z (4 months ago)
- Language: JavaScript
- Homepage: https://chrome.google.com/webstore/detail/redux-ship-devtools/kbcgcifbcgamdlgdahbfangmfiofpmni
- Size: 3.05 MB
- Stars: 5
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Redux Ship DevTools
> Side effects inspector for [Redux Ship](https://github.com/clarus/redux-ship).
Download on the [Chrome Web Store](https://chrome.google.com/webstore/detail/redux-ship-devtools/kbcgcifbcgamdlgdahbfangmfiofpmni).
[](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
(
control: (action: Action) => Ship
) => (action: Action) => Ship
```
Returns a function behaving as `control` but sending snapshots to the Redux Ship DevTools.