nextjs-websocket

1.0.11 • Public • Published

nextjs-websocket

nextjs-websocket is a easy-to-use NextJS component for websocket communications.

Notes

If you need me to build something, just raise an issue:)

This was a fork from react-websocket so s/o to the devs there :)

Installing

npm install --save nextjs-websocket

Usage

import React from 'react'
import { Websocket } from 'nextjs-websocket'

class ProductDetail extends React.Component {
  constructor(props) {
    super(props)
    this.state = {
      count: 90
    }
  }

  handleData(data) {
    let result = JSON.parse(data)
    this.setState({ count: this.state.count + result.movement })
  }

  render() {
    return (
      <div>
        Count: <strong>{this.state.count}</strong>
        <Websocket
          url='ws://localhost:8888/live/product/12345/'
          onMessage={this.handleData.bind(this)}
        />
      </div>
    )
  }
}

export default ProductDetail

Properties

url

required The url the websocket connection is listening to.

onMessage

required The callback called when data is received. Data is JSON.parse'd

onOpen

The callback called when the connection is successfully opened.

onClose

The callback called when the connection is closed either due to server disconnect or network error.

debug

default: false Set to true to see console logging

reconnect

default: true

accelerated reconnection time

License

FOSSA Status

/nextjs-websocket/

    Package Sidebar

    Install

    npm i nextjs-websocket

    Weekly Downloads

    920

    Version

    1.0.11

    License

    MIT

    Unpacked Size

    31.4 kB

    Total Files

    6

    Last publish

    Collaborators

    • adam_lamorre