26 |
27 |
28 | | Static Public Variable Summary | ||
| 50 | public 51 | 52 | 53 | 54 | 55 | | 56 |
57 |
58 |
64 | 59 | 60 | 61 | reduxBridge: ReduxSocketBridge 62 | 63 |
65 |
66 |
67 |
70 | Convenience singleton for |
71 | 72 | 73 | 74 | | 75 |
26 |
27 |
28 | 
1/1| File | 46 |Identifier | 47 |Document | 48 | 49 | 50 | 51 |
| src/index.js | 57 |reduxBridge | 58 |100 %1/1 | 59 | 60 | 61 | 62 |
26 |
27 |
28 | Channels Javascript wrapper for Redux.
42 |To process messages:
43 |import { ReduxBridge } from 'django_redux';
44 | import { store } from './mystore';
45 |
46 | const reduxBridge = new ReduxBridge();
47 | reduxBridge.connect();
48 | reduxBridge.listen(store);
49 | To send messages:
50 |reduxBridge.send({prop1: 'value1', prop2: 'value1'});
51 | To demultiplex specific streams:
52 |const reduxBridge = new ReduxBridge();
53 | reduxBridge.connect();
54 | reduxBridge.listen(store);
55 | reduxBridge.demultiplex('mystream', function(store, action, stream) {
56 | console.log(action, stream);
57 | store.dispatch(action);
58 | });
59 | reduxBridge.demultiplex('myotherstream', function(store, action, stream) {
60 | console.info(action, stream);
61 | store.dispatch(action);
62 | });
63 | To send a message to a specific stream:
64 |reduxBridge.stream('mystream').send({prop1: 'value1', prop2: 'value1'})
65 | import { WebSocketBridge } from 'django-channels';
42 |
43 |
44 | export class ReduxBridge extends WebSocketBridge {
45 | /**
46 | * Starts listening for messages on the websocket, demultiplexing if necessary.
47 | *
48 | * @param {Object} store Your redux store.
49 | * @param {Function} [cb] Callback to be execute when a message
50 | * arrives. The callback will receive `store`, `action` and `stream` parameters.
51 | * By default it will call `store.dispatch(action)`;
52 | *
53 | * @example
54 | * const webSocketBridge = new WebSocketBridge();
55 | * webSocketBridge.connect();
56 | * webSocketBridge.listen(store);
57 | */
58 | listen(store, cb = this.storeDispatch) {
59 | this.default_cb = cb;
60 | this.socket.onmessage = (event) => {
61 | const msg = JSON.parse(event.data);
62 | let action;
63 | let stream;
64 | if (msg.stream !== undefined) {
65 | action = msg.payload;
66 | stream = msg.stream;
67 | const stream_cb = this.streams[stream];
68 | stream_cb ? stream_cb(store, action, stream) : null;
69 | } else {
70 | action = msg;
71 | stream = null;
72 | this.default_cb ? this.default_cb(store, action, stream) : null;
73 | }
74 | };
75 |
76 | this.socket.onopen = () => {
77 | const state = store.getState();
78 |
79 | if (state.currentUser !== null) {
80 | // the connection was dropped. Call the recovery logic
81 | this.options.onreconnect(state);
82 | }
83 | };
84 | }
85 |
86 | storeDispatch(store, action, stream) {
87 | return store.dispatch(action);
88 | }
89 |
90 | }
91 |
92 | /**
93 | * Convenience singleton for `ReduxSocketBridge`.
94 | * @example
95 | * import { ReduxBridge } from 'django_redux';
96 | *
97 | * ReduxBridge.connect();
98 | * ReduxBridge.listen(store);
99 | *
100 | * @type {ReduxSocketBridge}
101 | */
102 | export const reduxBridge = new ReduxBridge();
103 | | Static Public Summary | ||
| 47 | public 48 | 49 | 50 | 51 | 52 | | 53 |
54 |
55 |
61 | 56 | 57 | 58 | reduxBridge: ReduxSocketBridge 59 | 60 |
62 |
63 |
64 |
67 | Convenience singleton for |
68 | 69 | 70 | 71 | | 72 |
import {reduxBridge} from 'django_redux/lib/index'Convenience singleton for ReduxSocketBridge.
import { ReduxBridge } from 'django_redux';
121 |
122 | ReduxBridge.connect();
123 | ReduxBridge.listen(store);