Search
Preparing search index...
The search index is not available
@nestjs/websockets
Options
All
Public
Public/Protected
All
Inherited
Externals
Only exported
Menu
Globals
SocketModule
Class SocketModule<HttpServer>
Type parameters
HttpServer =
any
Hierarchy
SocketModule
Index
Properties
application
Config
http
Server
is
Adapter
Initialized
sockets
Container
web
Sockets
Controller
Methods
close
combine
All
Gateways
combine
Gateway
And
Server
get
Context
Creator
initialize
Adapter
register
Properties
Private
application
Config
application
Config
:
ApplicationConfig
Private
http
Server
http
Server
:
HttpServer
|
undefined
Private
is
Adapter
Initialized
is
Adapter
Initialized
:
boolean
Private
Readonly
sockets
Container
sockets
Container
:
SocketsContainer
= new SocketsContainer()
Private
web
Sockets
Controller
web
Sockets
Controller
:
WebSocketsController
Methods
close
close
(
)
:
Promise
<
any
>
Returns
Promise
<
any
>
combine
All
Gateways
combine
All
Gateways
(
providers
:
Map
<
string
,
InstanceWrapper
<
Injectable
>
>
, moduleName
:
string
)
:
void
Parameters
providers:
Map
<
string
,
InstanceWrapper
<
Injectable
>
>
moduleName:
string
Returns
void
combine
Gateway
And
Server
combine
Gateway
And
Server
(
wrapper
:
InstanceWrapper
<
Injectable
>
, moduleName
:
string
)
:
void
Parameters
wrapper:
InstanceWrapper
<
Injectable
>
moduleName:
string
Returns
void
Private
get
Context
Creator
get
Context
Creator
(
container
:
NestContainer
)
:
WsContextCreator
Parameters
container:
NestContainer
Returns
WsContextCreator
Private
initialize
Adapter
initialize
Adapter
(
)
:
void
Returns
void
register
register
(
container
:
NestContainer
, config
:
ApplicationConfig
, httpServer
?:
HttpServer
)
:
void
Parameters
container:
NestContainer
config:
ApplicationConfig
Optional
httpServer:
HttpServer
Returns
void
Globals
Socket
Module
application
Config
http
Server
is
Adapter
Initialized
sockets
Container
web
Sockets
Controller
close
combine
All
Gateways
combine
Gateway
And
Server
get
Context
Creator
initialize
Adapter
register
Generated using
TypeDoc