Search
Preparing search index...
The search index is not available
@nestjs/websockets
Options
All
Public
Public/Protected
All
Inherited
Externals
Only exported
Menu
Globals
SocketServerProvider
Class SocketServerProvider
Hierarchy
SocketServerProvider
Index
Constructors
constructor
Properties
application
Config
sockets
Container
Methods
create
Socket
Server
create
With
Namespace
get
Server
OfNamespace
scan
For
Socket
Server
validate
Namespace
Constructors
constructor
new
Socket
Server
Provider
(
socketsContainer
:
SocketsContainer
, applicationConfig
:
ApplicationConfig
)
:
SocketServerProvider
Parameters
socketsContainer:
SocketsContainer
applicationConfig:
ApplicationConfig
Returns
SocketServerProvider
Properties
Private
Readonly
application
Config
application
Config
:
ApplicationConfig
Private
Readonly
sockets
Container
sockets
Container
:
SocketsContainer
Methods
Private
create
Socket
Server
create
Socket
Server<T>
(
options
:
T
, port
:
number
)
:
SocketEventsHost
Type parameters
T
:
GatewayMetadata
Parameters
options:
T
port:
number
Returns
SocketEventsHost
Private
create
With
Namespace
create
With
Namespace<T>
(
options
:
T
, port
:
number
, socketEventsHost
:
SocketEventsHost
)
:
SocketEventsHost
Type parameters
T
:
GatewayMetadata
Parameters
options:
T
port:
number
socketEventsHost:
SocketEventsHost
Returns
SocketEventsHost
Private
get
Server
OfNamespace
get
Server
OfNamespace<TOptions, TServer>
(
options
:
TOptions
, port
:
number
, server
:
TServer
)
:
any
Type parameters
TOptions
:
GatewayMetadata
TServer =
any
Parameters
options:
TOptions
port:
number
server:
TServer
Returns
any
scan
For
Socket
Server
scan
For
Socket
Server<T>
(
options
:
T
, port
:
number
)
:
SocketEventsHost
Type parameters
T
:
GatewayMetadata
Parameters
options:
T
port:
number
Returns
SocketEventsHost
Private
validate
Namespace
validate
Namespace
(
namespace
:
string
|
RegExp
)
:
string
|
RegExp
Parameters
namespace:
string
|
RegExp
Returns
string
|
RegExp
Globals
Socket
Server
Provider
constructor
application
Config
sockets
Container
create
Socket
Server
create
With
Namespace
get
Server
OfNamespace
scan
For
Socket
Server
validate
Namespace
Generated using
TypeDoc