# SocketIOModule Class
Module | import { SocketIOModule } from "@tsed/socketio" |
---|---|
Source | /packages/socketio/src/SocketIOModule.ts |
# Overview
class SocketIOModule implements AfterListen {
disableRoutesSummary<span class="token punctuation">:</span> <span class="token keyword">boolean</span><span class="token punctuation">;</span>
settings<span class="token punctuation">:</span> SocketIO.ServerOptions<span class="token punctuation">;</span>
httpPort<span class="token punctuation">:</span> <span class="token keyword">string</span> | <span class="token keyword">number</span><span class="token punctuation">;</span>
httpsPort<span class="token punctuation">:</span> <span class="token keyword">string</span> | <span class="token keyword">number</span><span class="token punctuation">;</span>
<span class="token keyword">constructor</span><span class="token punctuation">(</span>injector<span class="token punctuation">:</span> <a href="/api/di/services/InjectorService.html"><span class="token">InjectorService</span></a><span class="token punctuation">,</span> httpServer<span class="token punctuation">:</span> <a href="/api/common/platform-builder/decorators/HttpServer.html"><span class="token">HttpServer</span></a><span class="token punctuation">,</span> httpsServer<span class="token punctuation">:</span> <a href="/api/common/platform-builder/decorators/HttpsServer.html"><span class="token">HttpsServer</span></a><span class="token punctuation">,</span> io<span class="token punctuation">:</span> SocketIO.Server<span class="token punctuation">,</span> socketIOService<span class="token punctuation">:</span> <a href="/api/socketio/services/SocketIOService.html"><span class="token">SocketIOService</span></a><span class="token punctuation">)</span><span class="token punctuation">;</span>
$<span class="token function">afterListen</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">:</span> <span class="token keyword">void</span><span class="token punctuation">;</span>
/**
*
* @returns <span class="token punctuation">{</span><a href="/api/di/class/Provider.html"><span class="token">Provider</span></a><<span class="token keyword">any</span>><span class="token punctuation">[</span><span class="token punctuation">]</span><span class="token punctuation">}</span>
*/
<span class="token keyword">protected</span> <span class="token function">getWebsocketServices</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">:</span> <a href="/api/di/class/Provider.html"><span class="token">Provider</span></a><<span class="token keyword">any</span>><span class="token punctuation">[</span><span class="token punctuation">]</span><span class="token punctuation">;</span>
/**
*
*/
<span class="token keyword">protected</span> <span class="token function">printSocketEvents</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">:</span> <span class="token keyword">void</span><span class="token punctuation">;</span>
}
# Members
disableRoutesSummary: boolean;
settings: SocketIO.ServerOptions;
httpPort: string | number;
httpsPort: string | number;
$afterListen(): void;
protected getWebsocketServices(): Provider<any>[];
protected printSocketEvents(): void;
- Session & cookies
- Passport.js
- TypeORM
- Mongoose
- GraphQL
- Socket.io
- Swagger
- AJV
- Multer
- Serve static files
- Templating
- Throw HTTP Exceptions
- Customize 404
- AWS
- Jest
- Seq
- Controllers
- Providers
- Model
- Converters
- Middlewares
- Pipes
- Interceptors
- Authentication
- Hooks
- Injection scopes
- Custom providers
- Custom endpoint decorator
- Testing