Giter Club home page Giter Club logo

react-redux-websocket's Introduction

React-Redux-Websocket

A websocket Middleware

What it does?

This middleware send and receive actions from a server, dispatching as needed

const FOO = 'FOO';

function Bar() {
    return {
        type: FOO,
        payload: "Receive this"
        socket: {
            send: true
        }
    };
}

Installation and Usage

Installing

npm install react-redux-websocket

Then you create the socket and use ApplyMiddleware

import {createStore, applyMiddleware} from 'redux';
import reduxWebsocket from 'react-redux-websocket';

const socket = new WebSocket('ws://localhost:3030');
const store = createStore(rootReducer, applyMiddleware(reduxWebsocket(socket)));

Receiving actions

Any action received through the websocket will be dispatched and handled normally, so your reducers should handle them.

Dispatching actions

To send actions through the socket you need the special object socket with the key send set to true

const FOO = 'FOO';

function Bar() {
    return {
        type: FOO,
        payload: "Receive this"
        socket: {
            send: true
        }
    };
}

Configuration

The socket object has some properties that you can use, currently those properties are: send, keepSocket and silent.

const FOO = 'FOO';

function Bar() {
    return {
        type: FOO,
        socket: {
            send: true, // The action will be send through the socket, default: false
            keepSocket: false, // If false, the socket object will be removed after send, default: false
            silent: false // If true, it will not raise erros if fail to send, default: false
        }
    };
}

Test

run

npm test

License

react-redux-websocket is free and unencumbered software released into the public domain. See UNLICENSE for details.

react-redux-websocket's People

Contributors

igormael avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.