npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

socketset

v0.0.3

Published

Connect a socket.io server to a redux store.

Downloads

6

Readme

socketset

Connect a socket.io server to a redux store.

Installation

Inside of the client side application that includes a redux store, add the package with npm i socketset.

Usage

Integrating with Redux

The socketset module exports a function that returns a redux middleware function. To use it:

  1. Run this function, passing it the URL of the socket.io server.
  2. Pass the returned middleware to redux's applyMiddleware and compose functions with any other middleware.
  3. Pass the enhancer compose creates to redux's createStore function.
  4. Dispatch an action with the type 'SOCKETSET_CONNECT' to connect to socket.io.

Here is an example which also includes the redux developer tools and the redux-thunk package for illustrative purposes:

import { applyMiddleware, compose, createStore } from 'redux'
import reduxThunk from 'redux-thunk'
import socketset from 'socketset'

const devTools = window.__REDUX_DEVTOOLS_EXTENSION__
  ? window.__REDUX_DEVTOOLS_EXTENSION__()
  : x => x

// 1. Run the function and pass it the socket.io server URL
const socket = socketset('localhost:4000')

// 2. Pass the returned middleware to applyMiddleware and compose
const middleware = applyMiddleware(reduxThunk, socket)

const enhancer = compose(middleware, devTools)

// 3. Pass the created enhancer to createStore
const store = createStore(reducer, enhancer)

// 4. Dispatch a 'SOCKETSET_CONNECT' action
const action = { type: 'SOCKETSET_CONNECT' }
store.dispatch(action)

Dispatching actions from the server

Whenever the server emits an 'action' event to the client, if the message is a plain object, it will be dispatched directly to the redux store.

// Server side
io.emit(
  'action', // the event must be 'action'
  { type: 'PING' } // This action object will be sent directly to your reducers.
  // If they contain a 'case' for 'PING', it will be handled.
)

Configuring debug messages

By default, debug mode is on. If debug mode is on, you will see browser console logs confirming when you connecting, disconnecting, and receiving actions. To disable these logs, pass false as the second argument when initializing socketset.

socketset('localhost:4000', false) // Normal debug messages will not appear, though warnings about invalid actions will still appear.