npm.io
1.50.0 • Published 1 year ago

@totemorg/socketio

Licence
ISC
Version
1.50.0
Deps
1
Size
23 kB
Vulns
0
Weekly
0

SOCKETIO

Provides a form-fit-functional replacement for the notoriously buggy socket.io (and its socket.io-client client counterpart). Like its socket.io predecessors, SocketIO provides json-based web sockets, though it also has hooks to support binary sockets (for VoIP, video, etc) applications. SocketIO provides both a server-side and client-side modules that mimic the socket.io specification (less the bugs of course).

Install

npm install @totemorg/socketio
npm update

Start

npm run start ?					# List start options

Manage

npm run verminor				# Roll minor version
npm run vermajor				# Roll major version
npm run redoc					# Regen documentation
npm run pubminor				# republish as minor version
npm run pubmajor				# republish as major version

Usage

Acquire SocketIO as follows:

const SIO = require("@totemorg/socketio");

See the Program Reference for examples.

Program Reference

Open/Close ## Modules SOCKETIO

Replaces the buggy socket.io and socket.io-client modules. Documented in accordance with jsdoc.

ref: https://medium.com/hackernoon/implementing-a-websocket-server-with-node-js-d9b78ec5ffa8

SOCKETIO-CLIENT

The client-side of socketio. The socketio interface is established when the server does a require( "socketio"). This require creates an endpoint at socketio from which the client imports its client via the following