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

react-with-socket

v0.0.4

Published

Higher Order Component to communicate with sockets

Downloads

6

Readme

react-with-socket

A higher order component to manage socket communication in React.

Check out the live chat example and its source code.

Motivation

react-with-socket allows to separate handling of sockets and your UI. Its higher order component allows you to declare your handling of incoming events and to define actions, which are pure javascript functions which will send data over the socket.

Your presentational components can thus remain socket-agnostic and only need to deal with incoming props.

react-with-socket is not bound to a specific socket implementation. It integrates best with socket.io - check the API documentation for more.

Basic Example

import io from 'socket.io-client';
import withSocket, { setSocketConstructor } from 'react-with-socket';

setSocketConstructor(io) // define socket.io as our socket provider

const App = withSocket({
  initialState: {
    messages: []
  },
  mapData: () => ({
    // listen to message events and append the incoming message to our list of messages
    message: (props, message) => ({
      messages: [...props.messages, message ]
    })
  }),
  mapEmit: (emit) => ({
    // define an action creator to send data through the socket
    sendMessage: (message) => emit('message', message)
  })
})(({ messages, sendMessage })) => {
  return (
    <div>
      <ul>
        {
          messages.map((message, i) => (
            <li key={i}>{ message }</li>
          ))
        }
      </ul>
      <button onClick={ () => sendMessage('Some text!')}>Send a message!</button>
    </div>
  );
}

API Documentation

HOC

withSocket(config) => ((Component) => Component)

Configuration

setSocketConstructor((props) => Socket): void

Sets the default socket constructor function, which is used on componentWillMount, when the createSocket option is not specified.

A Socket needs to be of the following shape:

{
  on: ((event: String, data: Object) => void) => void
  emit: (event: String, data: Object) => void
  close: () => void
}

on listens to incoming data, identified by an event name.

emit sends data through the socket, identified by an event name. The data object needs to be serializable.

close is called when the component unmounts and should close the socket connection.

This is a subset of a Socket as defined by socket.io.


Brought to you by Team Outlaw @ Small Improvements