Registry / devops / simple-websocket-server

simple-websocket-server

library0.1.4jsnpmunverified

A WebSocket server package that mimics the Node.js `net` module API, yielding duplex streams instead of the traditional 'onmessage/send' WebSockets API. Version 0.1.4 is the latest stable release, though the package appears to be in early development with limited documentation and no recent updates. Compatible with simple-websocket, it is designed for IPFS and Protocol Labs projects, offering a stream-based approach for binary and text data. Differentiates from ws or socket.io by providing a Node.js stream interface, but lacks active maintenance.

devops

npm install simple-websocket-server

github ↗package ↗homepage ↗

INSTALL

IMPORT

SIG · SIMPLE-WEBSOCKET-S

simple-websocket-server

devopsjavascriptv0.1.4

harness data pending

Install & Compatibility

Where this runs

No compatibility data collected yet for this library.

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

default

✓ import Server from 'simple-websocket-server'

✗ const Server = require('simple-websocket-server')

Default export is a function to create a WebSocket server.

Server

✓ import { Server } from 'simple-websocket-server'

✗ const { Server } = require('simple-websocket-server')

Named export for the Server class, but most examples use default import.

Stream

✓ import { Stream } from 'simple-websocket'

✗ import { Stream } from 'simple-websocket-server'

The stream class is exported by the client package 'simple-websocket', not this server package.

Creates an HTTP server and attaches a WebSocket server, listening for duplex stream connections.

import WebSocketServer from 'simple-websocket-server' import http from 'http' const server = http.createServer() const wss = new WebSocketServer({ server }) wss.on('connection', (socket) => { console.log('New connection') socket.write('Hello client!') socket.on('data', (data) => { console.log('Received:', data.toString()) }) }) server.listen(8080, () => { console.log('Server listening on port 8080') })

Debug

Known issues

abandonedPackage appears unmaintained; no commits since 2017.

fix

Consider using more actively maintained alternatives like 'ws' or 'uWebSockets.js'.

affects: >=0.0.0

gotchaThe API expects an HTTP server object, not a port number.

fix

Always pass an http.createServer() instance to the constructor.

affects: >=0.0.0

gotchaDuplex streams may behave differently from raw WebSocket events; missing 'close' or 'error' event propagation.

fix

Implement custom error handling and monitor stream lifecycle.

affects: >=0.0.0

deprecatedPackage uses deprecated Buffer API in older versions.

fix

Update to latest version or use 'Buffer.from' explicitly.

affects: <0.1.0

Errors

Common errors & fixes

TypeError: WebSocketServer is not a constructor

Default import used with require() or wrong import style.

fix

Use import WebSocketServer from 'simple-websocket-server' or const WebSocketServer = require('simple-websocket-server').default

Error: The 'server' option is required

No HTTP server passed to constructor.

fix

const server = http.createServer(); const wss = new WebSocketServer({ server });

Cannot find module 'simple-websocket-server'

Package not installed or typo.

fix

npm install simple-websocket-server

Upgrade

Version history

0.1.4latest on npm

Audit

Dependencies

simple-websocketrequiredClient counterpart for the WebSocket stream interface

wsoptionalUnderlying WebSocket server implementation

Agent activity

5 hits · last 30 days

node

Resources

githubhttps://github.com/diasdavid/simple-websocket-server ↗

packagesimple-websocket-server ↗

homepagehttps://github.com/diasdavid/simple-websocket-server#readme ↗