/redux-saga-irc

Handful of utilities you should keep in your toolbelt to handle IRC connectivity in React

Primary LanguageTypeScriptMIT LicenseMIT

redux-irc

Handful of utilities you should keep in your toolbelt to handle IRC connectivity in React.

🚧 redux-irc is under development 🚧

Examples

Contents

Features

States available:

  • channels
  • connections
  • servers
  • users
  • errors
  • (soon) messages

Actions available:

  • connect
  • disconnect
  • join
  • leave
  • (soon) send message

Installation

$ npm i redux-irc

Setup

// src/store/index.js
import { createStore, combineReducers, applyMiddleware } from "@reduxjs/toolkit";
import { ircReducer, createSagaMiddleware, ircSagas } from "redux-irc";

const sagaMiddleware = createSagaMiddleware() // same as redux-sagas's
export const store = createStore(
    combineReducers({
        irc: ircReducer
    }),
    applyMiddleware(sagaMiddleware)
)
sagaMiddleware.run(ircSagas)

Contributions

PRs are more than welcome. If you're planning to contribute please make sure to read the contributing guide: CONTRIBUTING.md

Inspiration

Thanks to Martyn Smith for his awesome project Node IRC, which served me as inspiration for the react irc implementation.