# redux-autobahn-js > Autobahn-js middleware for Redux Latest version **0.1.2** (published 2018-07-10) · WTFPL license · 0 weekly downloads ## Install ```sh npm install redux-autobahn-js pnpm add redux-autobahn-js yarn add redux-autobahn-js bun add redux-autobahn-js ``` ## Health **Score 15/100 (F)** — status: abandoned. Positive: no vulnerabilities. Warnings: low downloads; no types; no esm support; pre 1.0. Negative: abandoned; low maintenance score. ## Facts | | | |---|---| | Version | 0.1.2 | | Published | 2018-07-10 | | First published | 2018-06-13 | | Weekly downloads | 0 | | License | WTFPL | | TypeScript types | none | | Module format | CommonJS | | Dependencies | 2 | | Unpacked size | 250.3 KB | | Known vulnerabilities | 0 | | Install scripts | no | | GitHub stars | 5 | | Author | Bryce Darling | | Maintainers | brycedarling | ## Links - npm: https://www.npmjs.com/package/redux-autobahn-js - Repository: https://github.com/brycedarling/redux-autobahn-js - Homepage: https://github.com/brycedarling/redux-autobahn-js#readme - Issues: https://github.com/brycedarling/redux-autobahn-js/issues - npm.io page: https://npm.io/package/redux-autobahn-js ## Dependencies (2) - [redux](https://npm.io/package/redux.md) ^3.7.2 - [autobahn](https://npm.io/package/autobahn.md) ^18.3.2 ## Recent versions - 0.1.2 (latest) — 2018-07-10 - 0.1.1 — 2018-06-13 - 0.1.0 — 2018-06-13 ## README # redux-autobahn-js ## Objects

redux-autobahn:actions : object
redux-autobahn:middleware : object
redux-autobahn:reducer : object
redux-autobahn:types : object

## redux-autobahn:actions : object **Kind**: global namespace * [redux-autobahn:actions](#redux-autobahn_actions) : object * [.openConnection()](#redux-autobahn_actions.openConnection) ⇒ object * [.closeConnection()](#redux-autobahn_actions.closeConnection) ⇒ object * [.subscribe(topic)](#redux-autobahn_actions.subscribe) ⇒ object * [.unsubscribe(subscriptionOrTopic)](#redux-autobahn_actions.unsubscribe) ⇒ object * [.publish(topic, args, kwargs, options)](#redux-autobahn_actions.publish) ⇒ object * [.register(procedure, endpoint, options)](#redux-autobahn_actions.register) ⇒ object * [.unregister(registration)](#redux-autobahn_actions.unregister) ⇒ object * [.call(procedure, args, kwargs, options, resultAction, errorAction)](#redux-autobahn_actions.call) ⇒ object ### redux-autobahn:actions.openConnection() ⇒ object Returns a redux action with type OPEN_CONNECTION **Kind**: static method of [redux-autobahn:actions](#redux-autobahn_actions) **Returns**: object - redux action ### redux-autobahn:actions.closeConnection() ⇒ object Returns a redux action with type CLOSE_CONNECTION **Kind**: static method of [redux-autobahn:actions](#redux-autobahn_actions) **Returns**: object - redux action ### redux-autobahn:actions.subscribe(topic) ⇒ object Returns a redux action with type SUBSCRIBE and the given topic **Kind**: static method of [redux-autobahn:actions](#redux-autobahn_actions) **Returns**: object - redux action | Param | Type | Description | | --- | --- | --- | | topic | string | The topic being subscribed to. | ### redux-autobahn:actions.unsubscribe(subscriptionOrTopic) ⇒ object Returns a redux action with type UNSUBSCRIBE and the given subscription or topic **Kind**: static method of [redux-autobahn:actions](#redux-autobahn_actions) **Returns**: object - redux action | Param | Type | Description | | --- | --- | --- | | subscriptionOrTopic | object \| string | The subscription or topic being unsubscribed from. | ### redux-autobahn:actions.publish(topic, args, kwargs, options) ⇒ object Returns a redux action with type PUBLISH and the given topic, args, kwargs, and options **Kind**: static method of [redux-autobahn:actions](#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. | ### redux-autobahn:actions.register(procedure, endpoint, options) ⇒ object Returns a redux action with type REGISTER and the given procedure, endpoint, and options **Kind**: static method of [redux-autobahn:actions](#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. | ### redux-autobahn:actions.unregister(registration) ⇒ object Returns a redux action with type UNREGISTER and the given registration object **Kind**: static method of [redux-autobahn:actions](#redux-autobahn_actions) **Returns**: object - redux action | Param | Type | Description | | --- | --- | --- | | registration | object | The registration object. | ### redux-autobahn:actions.call(procedure, args, kwargs, options, resultAction, errorAction) ⇒ object Returns a redux action with type CALL and the given procedure, args, kwargs, and options **Kind**: static method of [redux-autobahn:actions](#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. | ## redux-autobahn:middleware : object **Kind**: global namespace * [redux-autobahn:middleware](#redux-autobahn_middleware) : object * [.connected()](#redux-autobahn_middleware.connected) ⇒ object * [.disconnected()](#redux-autobahn_middleware.disconnected) ⇒ object * [.connectionOpened(connection)](#redux-autobahn_middleware.connectionOpened) ⇒ object * [.connectionClosed(reason, details)](#redux-autobahn_middleware.connectionClosed) ⇒ object * [.subscribed(subscription)](#redux-autobahn_middleware.subscribed) ⇒ object * [.subscribeError(error)](#redux-autobahn_middleware.subscribeError) ⇒ object * [.unsubscribed(subscription)](#redux-autobahn_middleware.unsubscribed) ⇒ object * [.unsubscribeError(error)](#redux-autobahn_middleware.unsubscribeError) ⇒ object * [.published(publication, topic, args, kwargs, options)](#redux-autobahn_middleware.published) ⇒ object * [.publishError(error)](#redux-autobahn_middleware.publishError) ⇒ object * [.event(topic, args, kwargs, details)](#redux-autobahn_middleware.event) ⇒ object * [.registered(registration)](#redux-autobahn_middleware.registered) ⇒ object * [.registerError(error)](#redux-autobahn_middleware.registerError) ⇒ object * [.unregistered(registration)](#redux-autobahn_middleware.unregistered) ⇒ object * [.unregisterError(error)](#redux-autobahn_middleware.unregisterError) ⇒ object * [.callError(error)](#redux-autobahn_middleware.callError) ⇒ object * [.result(procedure, args, kwargs, results, options)](#redux-autobahn_middleware.result) ⇒ object * [.isConnected(connection)](#redux-autobahn_middleware.isConnected) ⇒ boolean * [.getSubscription(action)](#redux-autobahn_middleware.getSubscription) ⇒ object * [.handleAction(connection, dispatch, next, action)](#redux-autobahn_middleware.handleAction) * [.assert(assertion, message)](#redux-autobahn_middleware.assert) * [.setConnection(newConnection)](#redux-autobahn_middleware.setConnection) * [.closeConnection(reason, message)](#redux-autobahn_middleware.closeConnection) ### redux-autobahn:middleware.connected() ⇒ object Returns a redux action with type CONNECTED **Kind**: static method of [redux-autobahn:middleware](#redux-autobahn_middleware) **Returns**: object - redux action ### redux-autobahn:middleware.disconnected() ⇒ object Returns a redux action with type DISCONNECTED **Kind**: static method of [redux-autobahn:middleware](#redux-autobahn_middleware) **Returns**: object - redux action ### redux-autobahn:middleware.connectionOpened(connection) ⇒ object Returns a redux action with type CONNECTION_OPENED and the given session object **Kind**: static method of [redux-autobahn:middleware](#redux-autobahn_middleware) **Returns**: object - redux action | Param | Type | Description | | --- | --- | --- | | connection | object | The object for the opened connection. | ### redux-autobahn:middleware.connectionClosed(reason, details) ⇒ object Returns a redux action with type CONNECTION_CLOSED **Kind**: static method of [redux-autobahn:middleware](#redux-autobahn_middleware) **Returns**: object - redux action | Param | Type | Description | | --- | --- | --- | | reason | string | reason for disconnection | | details | object | disconnect details | ### redux-autobahn:middleware.subscribed(subscription) ⇒ object Returns a redux action with type SUBSCRIBED and the given subscription object and it's topic **Kind**: static method of [redux-autobahn:middleware](#redux-autobahn_middleware) **Returns**: object - redux action | Param | Type | Description | | --- | --- | --- | | subscription | object | The subscription object for the topic that was subscribed to. | ### redux-autobahn:middleware.subscribeError(error) ⇒ object Returns a redux action with type SUBSCRIBE_ERROR and the given subscription error object **Kind**: static method of [redux-autobahn:middleware](#redux-autobahn_middleware) **Returns**: object - redux action | Param | Type | Description | | --- | --- | --- | | error | object | The error that occurred while subscribing. | ### redux-autobahn:middleware.unsubscribed(subscription) ⇒ object Returns a redux action with type UNSUBSCRIBED and the given subscription object and it's topic **Kind**: static method of [redux-autobahn:middleware](#redux-autobahn_middleware) **Returns**: object - redux action | Param | Type | Description | | --- | --- | --- | | subscription | object | The subscription object for the topic that was unsubscribed from. | ### redux-autobahn:middleware.unsubscribeError(error) ⇒ object Returns a redux action with type UNSUBSCRIBE_ERROR and the given unsubscription error object **Kind**: static method of [redux-autobahn:middleware](#redux-autobahn_middleware) **Returns**: object - redux action | Param | Type | Description | | --- | --- | --- | | error | object | The error that occurred while unsubscribing. | ### redux-autobahn:middleware.published(publication, topic, args, kwargs, options) ⇒ object Returns a redux action with type PUBLISHED and the given publication, topic, args, kwargs, and options **Kind**: static method of [redux-autobahn:middleware](#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. | ### redux-autobahn:middleware.publishError(error) ⇒ object Returns a redux action with type PUBLISH_ERROR and the given publish error object **Kind**: static method of [redux-autobahn:middleware](#redux-autobahn_middleware) **Returns**: object - redux action | Param | Type | Description | | --- | --- | --- | | error | object | The error that occurred while publishing. | ### redux-autobahn:middleware.event(topic, args, kwargs, details) ⇒ object Returns a redux action with type EVENT and the given topic, args, kwargs, and details **Kind**: static method of [redux-autobahn:middleware](#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. | ### redux-autobahn:middleware.registered(registration) ⇒ object Returns a redux action with type REGISTERED and the given registration object **Kind**: static method of [redux-autobahn:middleware](#redux-autobahn_middleware) **Returns**: object - redux action | Param | Type | Description | | --- | --- | --- | | registration | object | The registration object being registered to. | ### redux-autobahn:middleware.registerError(error) ⇒ object Returns a redux action with type REGISTER_ERROR and the given register error object **Kind**: static method of [redux-autobahn:middleware](#redux-autobahn_middleware) **Returns**: object - redux action | Param | Type | Description | | --- | --- | --- | | error | object | The error that occurred while registering. | ### redux-autobahn:middleware.unregistered(registration) ⇒ object Returns a redux action with type UNREGISTERED and the given registration object **Kind**: static method of [redux-autobahn:middleware](#redux-autobahn_middleware) **Returns**: object - redux action | Param | Type | Description | | --- | --- | --- | | registration | object | The registration object being unregistered from. | ### redux-autobahn:middleware.unregisterError(error) ⇒ object Returns a redux action with type UNREGISTER_ERROR and the given unregister error object **Kind**: static method of [redux-autobahn:middleware](#redux-autobahn_middleware) **Returns**: object - redux action | Param | Type | Description | | --- | --- | --- | | error | object | The error that occurred while unregistering. | ### redux-autobahn:middleware.callError(error) ⇒ object Returns a redux action with type CALL_ERROR and the given call error object **Kind**: static method of [redux-autobahn:middleware](#redux-autobahn_middleware) **Returns**: object - redux action | Param | Type | Description | | --- | --- | --- | | error | object | The error that occurred while calling. | ### redux-autobahn:middleware.result(procedure, args, kwargs, results, options) ⇒ object Returns a redux action with type RESULT and the given result value **Kind**: static method of [redux-autobahn:middleware](#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 | ### redux-autobahn:middleware.isConnected(connection) ⇒ boolean Returns a boolean that represents if the session for the connection exists and is open, therefore it is connected **Kind**: static method of [redux-autobahn:middleware](#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 | ### redux-autobahn:middleware.getSubscription(action) ⇒ object Returns the subscription from the action **Kind**: static method of [redux-autobahn:middleware](#redux-autobahn_middleware) **Returns**: object - the subscription on the action | Param | Type | Description | | --- | --- | --- | | action | object | the redux action | ### redux-autobahn:middleware.handleAction(connection, dispatch, next, action) Dispatches actions based on action types **Kind**: static method of [redux-autobahn:middleware](#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 | ### redux-autobahn:middleware.assert(assertion, message) Throws an error if the assertion is falsy **Kind**: static method of [redux-autobahn:middleware](#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 | ### redux-autobahn:middleware.setConnection(newConnection) Sets the passed connection for the middleware that dispatches opened and closed connection actions and handles actions **Kind**: static method of [redux-autobahn:middleware](#redux-autobahn_middleware) | Param | Type | Description | | --- | --- | --- | | newConnection | Connection | the connection object | ### redux-autobahn:middleware.closeConnection(reason, message) Closes the current autobahn connection **Kind**: static method of [redux-autobahn:middleware](#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 | ## redux-autobahn:reducer : object **Kind**: global namespace * [redux-autobahn:reducer](#redux-autobahn_reducer) : object * [.connection(state, action)](#redux-autobahn_reducer.connection) ⇒ object * [.session(state, action)](#redux-autobahn_reducer.session) ⇒ object * [.subscriptions(state, action)](#redux-autobahn_reducer.subscriptions) ⇒ object * [.registrations(state, action)](#redux-autobahn_reducer.registrations) ⇒ object ### redux-autobahn:reducer.connection(state, action) ⇒ object **Kind**: static method of [redux-autobahn:reducer](#redux-autobahn_reducer) **Returns**: object - the new state | Param | Type | Description | | --- | --- | --- | | state | object | the state | | action | object | redux action | ### redux-autobahn:reducer.session(state, action) ⇒ object **Kind**: static method of [redux-autobahn:reducer](#redux-autobahn_reducer) **Returns**: object - the new state | Param | Type | Description | | --- | --- | --- | | state | object | the state | | action | object | redux action | ### redux-autobahn:reducer.subscriptions(state, action) ⇒ object **Kind**: static method of [redux-autobahn:reducer](#redux-autobahn_reducer) **Returns**: object - the new state | Param | Type | Description | | --- | --- | --- | | state | object | the state | | action | object | redux action | ### redux-autobahn:reducer.registrations(state, action) ⇒ object **Kind**: static method of [redux-autobahn:reducer](#redux-autobahn_reducer) **Returns**: object - the new state | Param | Type | Description | | --- | --- | --- | | state | object | the state | | action | object | redux action | ## redux-autobahn:types : object **Kind**: global namespace * [redux-autobahn:types](#redux-autobahn_types) : object * [.CONNECTED](#redux-autobahn_types.CONNECTED) : string * [.DISCONNECTED](#redux-autobahn_types.DISCONNECTED) : string * [.OPEN_CONNECTION](#redux-autobahn_types.OPEN_CONNECTION) : string * [.CLOSE_CONNECTION](#redux-autobahn_types.CLOSE_CONNECTION) : string * [.CONNECTION_OPENED](#redux-autobahn_types.CONNECTION_OPENED) : string * [.CONNECTION_CLOSED](#redux-autobahn_types.CONNECTION_CLOSED) : string * [.SUBSCRIBE](#redux-autobahn_types.SUBSCRIBE) : string * [.SUBSCRIBED](#redux-autobahn_types.SUBSCRIBED) : string * [.SUBSCRIBE_ERROR](#redux-autobahn_types.SUBSCRIBE_ERROR) : string * [.UNSUBSCRIBE](#redux-autobahn_types.UNSUBSCRIBE) : string * [.UNSUBSCRIBED](#redux-autobahn_types.UNSUBSCRIBED) : string * [.UNSUBSCRIBE_ERROR](#redux-autobahn_types.UNSUBSCRIBE_ERROR) : string * [.PUBLISH](#redux-autobahn_types.PUBLISH) : string * [.PUBLISHED](#redux-autobahn_types.PUBLISHED) : string * [.PUBLISH_ERROR](#redux-autobahn_types.PUBLISH_ERROR) : string * [.EVENT](#redux-autobahn_types.EVENT) : string * [.REGISTER](#redux-autobahn_types.REGISTER) : string * [.REGISTERED](#redux-autobahn_types.REGISTERED) : string * [.REGISTER_ERROR](#redux-autobahn_types.REGISTER_ERROR) : string * [.UNREGISTER](#redux-autobahn_types.UNREGISTER) : string * [.UNREGISTERED](#redux-autobahn_types.UNREGISTERED) : string * [.UNREGISTER_ERROR](#redux-autobahn_types.UNREGISTER_ERROR) : string * [.CALL](#redux-autobahn_types.CALL) : string * [.CALL_ERROR](#redux-autobahn_types.CALL_ERROR) : string * [.RESULT](#redux-autobahn_types.RESULT) : string ### redux-autobahn:types.CONNECTED : string **Kind**: static constant of [redux-autobahn:types](#redux-autobahn_types) ### redux-autobahn:types.DISCONNECTED : string **Kind**: static constant of [redux-autobahn:types](#redux-autobahn_types) ### redux-autobahn:types.OPEN_CONNECTION : string **Kind**: static constant of [redux-autobahn:types](#redux-autobahn_types) ### redux-autobahn:types.CLOSE_CONNECTION : string **Kind**: static constant of [redux-autobahn:types](#redux-autobahn_types) ### redux-autobahn:types.CONNECTION_OPENED : string **Kind**: static constant of [redux-autobahn:types](#redux-autobahn_types) ### redux-autobahn:types.CONNECTION_CLOSED : string **Kind**: static constant of [redux-autobahn:types](#redux-autobahn_types) ### redux-autobahn:types.SUBSCRIBE : string **Kind**: static constant of [redux-autobahn:types](#redux-autobahn_types) ### redux-autobahn:types.SUBSCRIBED : string **Kind**: static constant of [redux-autobahn:types](#redux-autobahn_types) ### redux-autobahn:types.SUBSCRIBE_ERROR : string **Kind**: static constant of [redux-autobahn:types](#redux-autobahn_types) ### redux-autobahn:types.UNSUBSCRIBE : string **Kind**: static constant of [redux-autobahn:types](#redux-autobahn_types) ### redux-autobahn:types.UNSUBSCRIBED : string **Kind**: static constant of [redux-autobahn:types](#redux-autobahn_types) ### redux-autobahn:types.UNSUBSCRIBE_ERROR : string **Kind**: static constant of [redux-autobahn:types](#redux-autobahn_types) ### redux-autobahn:types.PUBLISH : string **Kind**: static constant of [redux-autobahn:types](#redux-autobahn_types) ### redux-autobahn:types.PUBLISHED : string **Kind**: static constant of [redux-autobahn:types](#redux-autobahn_types) ### redux-autobahn:types.PUBLISH_ERROR : string **Kind**: static constant of [redux-autobahn:types](#redux-autobahn_types) ### redux-autobahn:types.EVENT : string **Kind**: static constant of [redux-autobahn:types](#redux-autobahn_types) ### redux-autobahn:types.REGISTER : string **Kind**: static constant of [redux-autobahn:types](#redux-autobahn_types) ### redux-autobahn:types.REGISTERED : string **Kind**: static constant of [redux-autobahn:types](#redux-autobahn_types) ### redux-autobahn:types.REGISTER_ERROR : string **Kind**: static constant of [redux-autobahn:types](#redux-autobahn_types) ### redux-autobahn:types.UNREGISTER : string **Kind**: static constant of [redux-autobahn:types](#redux-autobahn_types) ### redux-autobahn:types.UNREGISTERED : string **Kind**: static constant of [redux-autobahn:types](#redux-autobahn_types) ### redux-autobahn:types.UNREGISTER_ERROR : string **Kind**: static constant of [redux-autobahn:types](#redux-autobahn_types) ### redux-autobahn:types.CALL : string **Kind**: static constant of [redux-autobahn:types](#redux-autobahn_types) ### redux-autobahn:types.CALL_ERROR : string **Kind**: static constant of [redux-autobahn:types](#redux-autobahn_types) ### redux-autobahn:types.RESULT : string **Kind**: static constant of [redux-autobahn:types](#redux-autobahn_types) --- _Source: https://npm.io/package/redux-autobahn-js · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._