Autobahn-js middleware for Redux
npm install redux-autobahn-jsobjectobjectobjectobjectobject* redux-autobahn:actions : object
* .openConnection() ⇒ object
* .closeConnection() ⇒ object
* .subscribe(topic) ⇒ object
* .unsubscribe(subscriptionOrTopic) ⇒ object
* .publish(topic, args, kwargs, options) ⇒ object
* .register(procedure, endpoint, options) ⇒ object
* .unregister(registration) ⇒ object
* .call(procedure, args, kwargs, options, resultAction, errorAction) ⇒ object
Kind: static method of redux-autobahn:actions
Returns: object - redux action
Kind: static method of redux-autobahn:actions
Returns: object - redux action
Kind: static method of redux-autobahn:actions
Returns: object - redux action
| Param | Type | Description |
| --- | --- | --- |
| topic | string | The topic being subscribed to. |
Kind: static method of redux-autobahn:actions
Returns: object - redux action
| Param | Type | Description |
| --- | --- | --- |
| subscriptionOrTopic | object \| string | The subscription or topic being unsubscribed from. |
Kind: static method of redux-autobahn:actions
Returns: object - redux action
| Param | Type | Description |
| --- | --- | --- |
| topic | string | The topic being subscribed to. |
| args | Array | An array of arguments. |
| kwargs | object | An object of keyword arguments. |
| options | object | An object of options. |
Kind: static method of redux-autobahn:actions
Returns: object - redux action
| Param | Type | Description |
| --- | --- | --- |
| procedure | string | The procedure name being registered. |
| endpoint | function | The endpoint function being registered. |
| options | object | An object of options. |
Kind: static method of redux-autobahn:actions
Returns: object - redux action
| Param | Type | Description |
| --- | --- | --- |
| registration | object | The registration object. |
Kind: static method of redux-autobahn:actions
Returns: object - redux action
| Param | Type | Description |
| --- | --- | --- |
| procedure | string | The procedure name being called. |
| args | Array | An array of arguments. |
| kwargs | object | An object of keyword arguments. |
| options | object | An object of options. |
| resultAction | object | (optional) An action to be dispatched on call success. |
| errorAction | object | (optional) An action to be dispatched on call error. |
object* redux-autobahn:middleware : object
* .connected() ⇒ object
* .disconnected() ⇒ object
* .connectionOpened(connection) ⇒ object
* .connectionClosed(reason, details) ⇒ object
* .subscribed(subscription) ⇒ object
* .subscribeError(error) ⇒ object
* .unsubscribed(subscription) ⇒ object
* .unsubscribeError(error) ⇒ object
* .published(publication, topic, args, kwargs, options) ⇒ object
* .publishError(error) ⇒ object
* .event(topic, args, kwargs, details) ⇒ object
* .registered(registration) ⇒ object
* .registerError(error) ⇒ object
* .unregistered(registration) ⇒ object
* .unregisterError(error) ⇒ object
* .callError(error) ⇒ object
* .result(procedure, args, kwargs, results, options) ⇒ object
* .isConnected(connection) ⇒ boolean
* .getSubscription(action) ⇒ object
* .handleAction(connection, dispatch, next, action)
* .assert(assertion, message)
* .setConnection(newConnection)
* .closeConnection(reason, message)
Kind: static method of redux-autobahn:middleware
Returns: object - redux action
Kind: static method of redux-autobahn:middleware
Returns: object - redux action
Kind: static method of redux-autobahn:middleware
Returns: object - redux action
| Param | Type | Description |
| --- | --- | --- |
| connection | object | The object for the opened connection. |
Kind: static method of redux-autobahn:middleware
Returns: object - redux action
| Param | Type | Description |
| --- | --- | --- |
| reason | string | reason for disconnection |
| details | object | disconnect details |
Kind: static method of redux-autobahn:middleware
Returns: object - redux action
| Param | Type | Description |
| --- | --- | --- |
| subscription | object | The subscription object for the topic that was subscribed to. |
Kind: static method of redux-autobahn:middleware
Returns: object - redux action
| Param | Type | Description |
| --- | --- | --- |
| error | object | The error that occurred while subscribing. |
Kind: static method of redux-autobahn:middleware
Returns: object - redux action
| Param | Type | Description |
| --- | --- | --- |
| subscription | object | The subscription object for the topic that was unsubscribed from. |
Kind: static method of redux-autobahn:middleware
Returns: object - redux action
| Param | Type | Description |
| --- | --- | --- |
| error | object | The error that occurred while unsubscribing. |
Kind: static method of redux-autobahn:middleware
Returns: object - redux action
| Param | Type | Description |
| --- | --- | --- |
| publication | string | The publication being published to. |
| topic | string | The topic being published to. |
| args | Array | An array of arguments. |
| kwargs | object | An object of keyword arguments. |
| options | object | An object of options. |
Kind: static method of redux-autobahn:middleware
Returns: object - redux action
| Param | Type | Description |
| --- | --- | --- |
| error | object | The error that occurred while publishing. |
Kind: static method of redux-autobahn:middleware
Returns: object - redux action
| Param | Type | Description |
| --- | --- | --- |
| topic | string | The topic being published to. |
| args | Array | An array of arguments. |
| kwargs | object | An object of keyword arguments. |
| details | object | An object of event details. |
Kind: static method of redux-autobahn:middleware
Returns: object - redux action
| Param | Type | Description |
| --- | --- | --- |
| registration | object | The registration object being registered to. |
Kind: static method of redux-autobahn:middleware
Returns: object - redux action
| Param | Type | Description |
| --- | --- | --- |
| error | object | The error that occurred while registering. |
Kind: static method of redux-autobahn:middleware
Returns: object - redux action
| Param | Type | Description |
| --- | --- | --- |
| registration | object | The registration object being unregistered from. |
Kind: static method of redux-autobahn:middleware
Returns: object - redux action
| Param | Type | Description |
| --- | --- | --- |
| error | object | The error that occurred while unregistering. |
Kind: static method of redux-autobahn:middleware
Returns: object - redux action
| Param | Type | Description |
| --- | --- | --- |
| error | object | The error that occurred while calling. |
Kind: static method of redux-autobahn:middleware
Returns: object - redux action
| Param | Type | Description |
| --- | --- | --- |
| procedure | object | Procedure that was called |
| args | object | Arguments with which procedure was called |
| kwargs | object | Arguments with which procedure was called |
| results | object | Call results |
| options | object | Options |
Kind: static method of redux-autobahn:middleware
Returns: boolean - returns true if the session for the connection exists and is open
| Param | Type | Description |
| --- | --- | --- |
| connection | object | the connection object |
Kind: static method of redux-autobahn:middleware
Returns: object - the subscription on the action
| Param | Type | Description |
| --- | --- | --- |
| action | object | the redux action |
Kind: static method of redux-autobahn:middleware
| Param | Type | Description |
| --- | --- | --- |
| connection | object | the connection object |
| dispatch | function | the dispatch function |
| next | function | the next function |
| action | object | the redux action |
Kind: static method of redux-autobahn:middleware
Throws:
- Error throws an error with the given message if the assertion is falsy
| Param | Type | Description |
| --- | --- | --- |
| assertion | object | the assertion expression |
| message | object | the assertion message |
Kind: static method of redux-autobahn:middleware
| Param | Type | Description |
| --- | --- | --- |
| newConnection | Connection | the connection object |
Kind: static method of redux-autobahn:middleware
| Param | Type | Description |
| --- | --- | --- |
| reason | string | (optional) a WAMP URI providing a closing reason to the server side (e.g. 'com.myapp.close.signout'). default is wamp.goodbye.normal |
| message | string | human-readable closing message |
object* redux-autobahn:reducer : object
* .connection(state, action) ⇒ object
* .session(state, action) ⇒ object
* .subscriptions(state, action) ⇒ object
* .registrations(state, action) ⇒ object
redux-autobahn:reducer object - the new state | Param | Type | Description |
| --- | --- | --- |
| state | object | the state |
| action | object | redux action |
redux-autobahn:reducer object - the new state | Param | Type | Description |
| --- | --- | --- |
| state | object | the state |
| action | object | redux action |
redux-autobahn:reducer object - the new state | Param | Type | Description |
| --- | --- | --- |
| state | object | the state |
| action | object | redux action |
redux-autobahn:reducer object - the new state | Param | Type | Description |
| --- | --- | --- |
| state | object | the state |
| action | object | redux action |
object* redux-autobahn:types : object
* .CONNECTED : string
* .DISCONNECTED : string
* .OPEN_CONNECTION : string
* .CLOSE_CONNECTION : string
* .CONNECTION_OPENED : string
* .CONNECTION_CLOSED : string
* .SUBSCRIBE : string
* .SUBSCRIBED : string
* .SUBSCRIBE_ERROR : string
* .UNSUBSCRIBE : string
* .UNSUBSCRIBED : string
* .UNSUBSCRIBE_ERROR : string
* .PUBLISH : string
* .PUBLISHED : string
* .PUBLISH_ERROR : string
* .EVENT : string
* .REGISTER : string
* .REGISTERED : string
* .REGISTER_ERROR : string
* .UNREGISTER : string
* .UNREGISTERED : string
* .UNREGISTER_ERROR : string
* .CALL : string
* .CALL_ERROR : string
* .RESULT : string
redux-autobahn:types redux-autobahn:types redux-autobahn:types redux-autobahn:types redux-autobahn:types redux-autobahn:types redux-autobahn:types redux-autobahn:types redux-autobahn:types redux-autobahn:types redux-autobahn:types redux-autobahn:types redux-autobahn:types redux-autobahn:types redux-autobahn:types redux-autobahn:types redux-autobahn:types redux-autobahn:types redux-autobahn:types redux-autobahn:types redux-autobahn:types redux-autobahn:types redux-autobahn:types redux-autobahn:types redux-autobahn:types