@boolmind/websocket-gateway

A NestJS-style WebSocket gateway package for handling real-time communication using Socket.IO. Easily integrate WebSocket support into your NestJS applications.

Features

• NestJS-like module and gateway structure
• Handles connection, disconnection, and message events
• Emits and receives messages using Socket.IO
• Ready for Docker and CI/CD
• Includes Husky pre-commit hooks and Jest tests

Installation

npm install @boolmind/websocket-gateway

Usage

import { Module } from '@nestjs/common';
import { WebsocketModule } from '@boolmind/websocket-gateway';

@Module({
  imports: [WebsocketModule],
})
export class AppModule {}

Gateway Example

import { WebsocketGateway } from '@boolmind/websocket-gateway';

// Use as a provider or extend for custom logic

Scripts

• npm run build — Build TypeScript
• npm run test — Run Jest tests
• npm start — Start the built app

Docker

Build and run with Docker:

docker build -t boolmind-websocket-gateway .
docker run -p 3000:3000 boolmind-websocket-gateway

Testing

npm run test

Contributing

1. Fork the repo
2. Create your feature branch (git checkout -b feature/fooBar)
3. Commit your changes (git commit -am 'Add some fooBar')
4. Push to the branch (git push origin feature/fooBar)
5. Create a new Pull Request

License

MIT