# socket.io-subscriber-middleware

> Redux middleware to emit actions to a socket.io server

Latest version **1.0.2** (published 2019-09-05) · MIT license · 0 weekly downloads

## Install

```sh
npm install socket.io-subscriber-middleware
pnpm add socket.io-subscriber-middleware
yarn add socket.io-subscriber-middleware
bun add socket.io-subscriber-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.2 |
| Published | 2019-09-05 |
| First published | 2019-08-27 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 3.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Pavanello Emanuele |
| Maintainers | epavanello |
| Keywords | redux, middleware, socket.io, subscriber |

## Links

- npm: https://www.npmjs.com/package/socket.io-subscriber-middleware
- Repository: https://github.com/epavanello/socket.io-subscriber-middleware
- Homepage: https://github.com/epavanello/socket.io-subscriber-middleware#readme
- Issues: https://github.com/epavanello/socket.io-subscriber-middleware/issues
- npm.io page: https://npm.io/package/socket.io-subscriber-middleware

## Alternatives

- [@opentelemetry/exporter-zipkin](https://npm.io/package/@opentelemetry/exporter-zipkin.md) — 14.8M weekly downloads
- [pusher-js](https://npm.io/package/pusher-js.md) — 2.0M weekly downloads
- [browserify](https://npm.io/package/browserify.md) — 1.7M weekly downloads
- [sqs-consumer](https://npm.io/package/sqs-consumer.md) — 1.7M weekly downloads
- [@sanity/eventsource](https://npm.io/package/@sanity/eventsource.md) — 930.8K weekly downloads

## Recent versions

- 1.0.2 (latest) — 2019-09-05
- 1.0.1 — 2019-09-05
- 1.0.0 — 2019-08-27

## README

# socket.io-subscriber-middleware
Redux middleware to subscribe events from socket.io server

## API
### Apply middleware
```javascript
import io from 'socket.io-client';
import { createStore, applyMiddleware } from 'redux';

import socketIOSubscriberMiddleware from 'socket.io-subscriber-middleware';

import reducer from './reducer';

const socket = io.connect(process.env.SOCKET_URL);

const store = createStore(reducer, applyMiddleware(
  socketIOSubscriberMiddleware(socket)
));
```
* `socketIOSubscriberMiddleware` receive a `socket` instance created by `io.connect(<url>)`.

### Example action
```javascript
const action = {
  type: 'BIND_USER_JOINED',
  socket: {
    subscribe: {
      event: 'onlogin',
      handle: (socketResponse) => {
        // Your callback here
      }
    }
  }
};

const action = {
  type: 'BIND_USER_JOINED',
  socket: {
    subscribe: {
      event: 'onlogin',
      responseType: 'NEW_USER_JOINED'
    }
  }
};

const action = {
  type: 'UNBIND_USER_JOINED',
  socket: {
    unsubscribe: {
      event: 'onlogin'
    }
  }
};
```
* `socket.subscribe.event` define the socket.io event to bind.
* `socket.subscribe.handle` (optional) function callback called when the binded event is fired from server. The data is passed as first parameter.
* `socket.subscribe.responseType` (optional) name of action type raised in redux with server data as payload.

## Installation

```
npm i socket.io-subscriber-middleware
```

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