Redux-kittens NPM

Redux KITtens 🐾

Redux middleware kit Simple way to create http requests, create and manage websockets, timer, promises etc. - just pass the plain objects objects as a payload. Also every KITten already have the built-in logger, so no need to add some other logging middleware.

Installation

npm install -s redux-kittens

Usage

Timer kitten - timer middleware
Delay kitten - delay middleware
Superagent kitten - http request middleware
Socket.io kitten - Socket.io client middleware
Storage kitten - localStorage and AsyncStorage middleware
Promise kitten - promise middleware

Global settings

import {
  reduxKittens, /* all in one initialization */

  delayKitten, ... /* or add only kittens you need */
} from 'redux-kittens';

const options = {enableLog: true};

const store = applyMiddleware( ...reduxKittens(options) )(createStore)(reducer); // Apply all the middlewares
   OR
const store = applyMiddleware( /* one by one */
  delayKitten(options),
  timerKitten(options),
  superagentKitten(options),
  socketIoKitten(options),
  storageKitten(options),
  promiseKitten(options)
)(createStore)(reducer);

🐱 Timer kitten

timerKitten(options)

Payload should be a plain object with properties:

use: 'timer'
method - 'start' or 'stop'
id - timer's ID, optional (you can have several timers with the different IDs)
interval - interval in ms

Start timer

store.dispatch({ 
  type: 'TIMER_CALL', //or whatever you want
  payload: {
      use: 'timer',
      method: 'start',
      id: 'my_timer_number_one', 
      interval: 1000 //one second      
    }
  });

In the reducer you will get: { meta: { sequence: 'start' }} and then { meta: { sequence: 'tick', iteration: NN /* number of iteration */ }} on every timer's call. If the timer with this name is already started this action call will be ignored.

Stop timer

...
  payload: {
      use: 'timer',
      method: 'stop',
      name: 'my_timer_number_one',
    }

In the reducer you will get: { meta: { sequence: 'stop' }}

Restart timer

...
  payload: {
      use: 'timer',
      method: 'restart',
      name: 'my_timer_number_one',
    }

options

enableLog - set to true to enable console logging

🐱 Delay kitten

delayKitten(options)

Payload should be a plain object with properties:

use: 'delay'
delay - interval in ms

Reducer events:

{ meta: { sequence: 'begin' }} - after right the delay creation
{ meta: { sequence: 'complete' }} - at the end of the interval

options

enableLog - set to true to enable console logging

🐱 Superagent kitten

superagentKitten(options)

Middleware for the async requests via http and https. It uses promisified superagent library.

Payload should be a plain object with properties:

use: 'request'
url
method - 'GET', 'POST' etc.
query - request query, as an object
data - request payload
accept
boundary
sendAsForm - set to true if you want to send the data as a form
contentType
files - pass here the FileList object if you want to upload the files, the form will be created automatically, content of the data will be added as a form fields
allowedFileTypes - array, MIME file types for upload, or just image or video - all the other files will be ignored
reportProgress - set it to true if you want to receive the events about the operation progress, for example during the uploading of the large files

Create request

store.dispatch({ 
  type: 'GET_REMOTE_URL', //or whatever you want
  payload: {
      use: 'request',
      method: 'GET',
      url: 'https://your.site/api'      
    }
  });

Reducer events

{ meta: { sequence: 'begin' }} - request was made
{ meta: { sequence: 'complete' }, payload: { ...dataFromServer }} - data recieved
{ meta: { sequence: 'error' }, payload: { ...ErrorData }} - error during the request

options

enableLog - set to true to enable console logging
getToken - optional function, provide auth token here, getToken: () => yourCustomToken

Authentication

Middleware automatically gets the value of the store session.token (supported both plain JS object and Immutable reducers), it will be send in the 'Authorization' header field. If you want to manually specify the 'Authorization' header value, use the getToken parameter in the options

🐱 Socket.io kitten

socketIoKitten(options)

Middleware for socket.io. It uses socket.io-client library.

Payload should be a plain object with properties:

use: 'socketIo'
url
method - connect or disconnect
name - socket name
query - query params for connection
listeners: [] - array of listeners, 'connect', 'disconnect', custom event names

Connect to server

store.dispatch({ 
  type: 'TIMER_CALL', //or whatever you want
  payload: {
    use: 'socketIo',
    method: 'connect',
    name: 'someSocket',
    url: 'https://your.site/socket_io',
    query: { id: 2 },
    listeners: ['connect', 'disconnect', YOUR_EVENT_NAME, ...]
  }
});

Reducer events

{ meta: { sequence: 'sequence: 'connectRequest' }} - rigth after the 'connect' action call
{ meta: { sequence: 'connect' }} - connected to server
{ meta: { sequence: 'disconnect' }} - disconnected to server
{ meta: { sequence: YOUR_EVENT_NAME }} - when socket receives YOUR_EVENT_NAME from the server. YOUR_EVENT_NAME should be in the listeners list

options

enableLog - set to true to enable console logging
getToken - optional function, provide auth token here, getToken: () => yourCustomToken
socketOptions - look the socket.io-client documentation