JSPM

universal-websocket-client

1.0.3
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 24731
  • Score
    100M100P100Q145859F
  • License ISC

Use the same WebSocket client code in a browser or Node.js for isomorphic apps

Package Exports

  • universal-websocket-client
  • universal-websocket-client/browser.js
  • universal-websocket-client/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (universal-websocket-client) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Uses the native WebSocket client code in a browser and the ws package client on Node.js, enabling isomorphic applications to use WebSockets. Keeps your browser build slim, by not including any of the Node WebSocket implementation.

Installation

npm install --save universal-websocket-client

Usage

var WebSocket = require('universal-websocket-client');

\\ ... use the [WebSocket client interface](https://developer.mozilla.org/en-US/docs/Web/API/WebSocket).

On the client side, you'll now need to use browserify (or Webpack or something similar) to bundle your code.

See tests/browser and tests/node

Run Tests

These are end-to-end tests, that test the installed the package.

Node

cd tests/browser/
npm install
npm test

Browser

cd tests/node/
npm install
npm test

Then visit http://localhost:8000