Quick Start

1. Mount the UI

import { WsgateModule } from '@wsgate/nest';

async function bootstrap() {
  const app = await NestFactory.create(AppModule);
  await WsgateModule.setup('/wsgate', app, { title: 'My App' });
  await app.listen(3000);
}
bootstrap();

No extra imports or providers needed in your root module.

2. Document your events

import { WsDoc } from '@wsgate/nest';

@WsDoc({
  event: 'message:send',
  description: 'Send a message to a room.',
  payload: { room: 'string', text: 'string' },
  response: 'message:receive',
  type: 'emit',
})
@SubscribeMessage('message:send')
handleSendMessage(@MessageBody() data: any) {}

Open http://localhost:3000/wsgate — done.