Registry /
messaging / websocket-conference-server
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.
start
✓ var server = require('websocket-conference-server').start();
✗ const { start } = require('websocket-conference-server'); // Works but not idiomatic for this module
CommonJS only; no ESM export. `.start()` is a method on the exported object.
default export
✓ var wscs = require('websocket-conference-server'); wscs.start(config, utilities);
✗ import wscs from 'websocket-conference-server'; // ESM not supported
The module exports an object with a `start` method. No default export.
config object
✓ var config = { verbosity: 1, protocol: 'my-custom-protocol', port: 8001, logs_path: 'Logs/', IP_lookup_path: 'IPs/', logs_suffix: '-alpha.log', http_paths: { 'ico': '../Assets', 'jpg': '../Assets', 'png': '../Assets', 'html': '..', 'css': '..', 'js': '..' } };
✗ var config = { verbose: true }; // Wrong property name
Config properties must match exactly: verbosity (number), protocol (string), port (number), logs_path (string), IP_lookup_path (string), logs_suffix (string), http_paths (object with extension->path mappings).
custom_utilities
✓ var custom_utilities = require('./my_custom_utilities'); server.start(config, custom_utilities);
✗ server.start(config, { augment: (u) => u }); // Should be a module that augments utilities object
The second argument is a module whose exported `augment` function receives and returns the utilities object.
Starts default server on port 8000 with echo protocol and console logging.
var server = require('websocket-conference-server').start();
console.log('Server listening on port 8000');
Errors
Common errors & fixes
Error: Cannot find module 'websocket'
Dependency 'websocket' not installed automatically in some npm versions.
fixRun: npm install websocket
TypeError: server.start is not a function
Importing module incorrectly; expecting `start` as a standalone export.
fixUse: var server = require('websocket-conference-server'); server.start(); ReferenceError: my-custom-protocol is not defined
Protocol name must be a string, not a variable without quotes.
fixSet config.protocol = 'my-custom-protocol';
Audit
Dependencies
websocketrequiredWebSocket-Node module is the core WebSocket implementation