maru-packge

Lightweight Socket.IO chat wrappers for server and client.

Install

npm install maru-packge

Usage

Server (Node.js)

const { createChatServer } = require('maru-packge');

const server = createChatServer({ port: 4000, corsOrigin: '*' });
server.start();

Client (browser/Node)

const { createChatClient } = require('maru-packge');

const client = createChatClient({ url: 'http://localhost:4000' });
client.connect();
client.joinRoom('room-1');
client.onMessage((m) => console.log('message:', m));
client.sendMessage('room-1', 'user-1', 'hello');

API

• createChatServer(options)
  • port (default: 3000)
  • corsOrigin (default: *)
  • path (default: /socket.io)
• createChatClient(options)
  • url (required)
  • path (default: /socket.io)
  • transports (default: ['websocket'])
  • autoConnect (default: true)

Events:

• room:join, room:leave
• chat:send to emit a message
• chat:message to receive a message
• chat:typing typing indicator

Develop

• Start example server: npm run dev:server
• Start example client: npm run dev:client

Publish

1. Update the package name to a unique value in package.json
2. Build: npm run build
3. Publish: npm publish --access public

MIT License