Registry / messaging / onedionys-websocket-wrapper

onedionys-websocket-wrapper

library5.0.0jsnpmunverified

One Dionys WebSocket Wrapper v5.0.0 provides a lightweight abstraction over the native WebSocket API, offering simplified syntax for opening connections, sending messages, and handling events like open, message, error, and close. Released on 31 March 2024, it is part of the One Dionys ecosystem and includes ongoing updates. Key differentiators include an easy-to-use interface and a focus on browser environments, though it lacks built-in reconnection, heartbeat, or advanced state management found in alternatives like `ws` or `socket.io`.

messaging

npm install onedionys-websocket-wrapper

github ↗package ↗homepage ↗

INSTALL

IMPORT

SIG · ONEDIONYS-WEBSOCKE

onedionys-websocket-wrapper

messagingjavascriptv5.0.0

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.

WebSocketWrapper

✓ const WebSocketWrapper = require('onedionys-websocket-wrapper');

✗ import WebSocketWrapper from 'onedionys-websocket-wrapper';

This package uses CommonJS and does not provide ESM exports. Use require() to avoid import errors.

WebSocketWrapper

✓ const WS = require('onedionys-websocket-wrapper'); const socket = new WS('ws://localhost:8080');

✗ const socket = new WebSocket('ws://localhost:8080');

Do not confuse with the native WebSocket constructor; always use the library's wrapper.

WebSocketWrapper

✓ const { WebSocketWrapper } = require('onedionys-websocket-wrapper');

✗ const { WebSocket } = require('onedionys-websocket-wrapper');

The package exports a single class named WebSocketWrapper, not WebSocket.

Create a WebSocket connection using the wrapper, send a message, log received data, and handle events.

const WebSocketWrapper = require('onedionys-websocket-wrapper'); const socket = new WebSocketWrapper('wss://echo.websocket.org'); socket.on('open', () => { console.log('Connected'); socket.send('Hello, world!'); }); socket.on('message', (data) => { console.log('Received:', data); socket.close(); }); socket.on('error', (err) => console.error('Error:', err)); socket.on('close', () => console.log('Disconnected'));

Debug

Known issues

gotchaThe package currently does not support ESM imports. Use CommonJS require() to avoid syntax errors.

fix

Use const WebSocketWrapper = require('onedionys-websocket-wrapper');

affects: <=5.0.0

gotchaNo built-in reconnection. Disconnections require manual re-instantiation.

fix

Implement custom reconnection logic in the 'close' event handler.

affects: >=1.0.0

gotchaThe wrapper may not expose all native WebSocket properties (e.g., readyState, bufferedAmount). Check documentation.

fix

Access underlying socket via internal property if needed, or test with your use case.

affects: <=5.0.0

Errors

Common errors & fixes

Error: Cannot find module 'onedionys-websocket-wrapper'

Package not installed or typo in npm install command.

fix

Run 'npm install onedionys-websocket-wrapper' and verify package.json.

TypeError: WebSocketWrapper is not a constructor

Incorrect import style (ESM import used for CommonJS module).

fix

Change to const WebSocketWrapper = require('onedionys-websocket-wrapper');

WebSocket connection to 'ws://localhost:8080' failed: Error in connection establishment: net::ERR_CONNECTION_REFUSED

Server not running or wrong URL.

fix

Ensure WebSocket server is listening at the specified address. Use wss:// for secure connections if needed.

Upgrade

Version history

5.0.0latest on npm

Audit

Dependencies

wsoptionalOptional peer dependency for Node.js environments if native WebSocket is unavailable.

Agent activity

15 hits · last 30 days

node

OpenAI (training)

Resources

githubhttps://github.com/onedionys/onedionys-websocket-wrapper ↗

packageonedionys-websocket-wrapper ↗

homepagehttps://github.com/onedionys/onedionys-websocket-wrapper#readme ↗