disconnectPhoenix

This method will disconnect the phoenix socket

import { disconnectPhoenix } from '@trixtateam/phoenix-to-redux';

Events

All the events associated with the socket

connectPhoenix

This method will setup and connect the phoenix socket

import { connectPhoenix } from '@trixtateam/phoenix-to-redux';

Socket

All the methods and events associated with the socket

API Reference

SOCKET_ERROR

Should an error occur from the phoenix socket, the following redux event is dispatched

import { socketActionTypes } from '@trixtateam/phoenix-to-redux';
const { SOCKET_ERROR } = socketActionTypes;

Methods

All the methods associated with the socket

Channel

All the methods and events associated with the socket channels

SOCKET_OPEN

Should the socket attempt to open, the following redux event is dispatched

SOCKET_CLOSE

Should the socket attempt to close, the following redux event is dispatched

SOCKET_CONNECT

Should the socket attempt to connect, the following redux event is dispatched

SOCKET_DISCONNECT

Should the socket attempt to disconnect, the following redux event is dispatched

leavePhoenixChannelEvent

This method will unsubscribe for the given event for the given channelTopic

getPhoenixChannel

This method will subscribe phoenix channel for the given channelTopic and given events

Methods

All the methods associated with the socket channels

CHANNEL_ERROR

Should an error occur from the phoenix socket channel, the following redux event is dispatched. Invoked if the socket connection drops, or the channel crashes on the server.

Events

All the events associated with the socket channels

CHANNEL_JOIN

After joining a phoenix channel, the following redux event is dispatched.

import { channelActionTypes } from '@trixtateam/phoenix-to-redux';
const { CHANNEL_JOIN } = channelActionTypes;

leavePhoenixChannelEvents

This method will unsubscribe for the given events for the given channelTopic

import { leavePhoenixChannelEvents } from '@trixtateam/phoenix-to-redux';

CHANNEL_JOIN_ERROR

Should an error occur from the phoenix socket channel, the following redux event is dispatched. Error response after joining the phoenix channel.

import { channelActionTypes } from '@trixtateam/phoenix-to-redux';
const { CHANNEL_JOIN_ERROR } = channelActionTypes;

CHANNEL_CLOSE

Should a phoenix channel be explicitly closed on the server or the channel was explicitly closed by calling channel.leave(). The following redux event is dispatched

import { channelActionTypes } from '@trixtateam/phoenix-to-redux';
const { CHANNEL_CLOSE } = channelActionTypes;

pushPhoenixChannel

This method will attempt to find the subscribed phoenix channel for the given channelTopic and push data to the channel for the eventName.

leavePhoenixChannel

This method will leave the phoenix channel for the given channelTopic and unsubscribes off of channel events

CHANNEL_LEAVE

After phoenix channel is left. The following redux event is dispatched

CHANNEL_PUSH_ERROR

Should an error occur from the phoenix socket channel, the following redux event is dispatched. Error response after pushing data to phoenix channel.

import { channelActionTypes } from '@trixtateam/phoenix-to-redux';
const { CHANNEL_PUSH_ERROR } = channelActionTypes;

CHANNEL_TIMEOUT

Should an error occur from the phoenix socket channel, the following redux event is dispatched. Timeout error response after joining the phoenix channel.

import { channelActionTypes } from '@trixtateam/phoenix-to-redux';
const { CHANNEL_TIMEOUT } = channelActionTypes;