rest-vir - v2.2.0
Preparing search index...
ConnectTestWebSocket
Type Alias ConnectTestWebSocket<Api>
ConnectTestWebSocket
:
<
const
ThisWebSocket
extends
WebSocketDefinition
&
{
path
:
keyof
Api
[
"definition"
]
[
"webSockets"
]
}
,
WebSocketClass
extends
CommonWebSocket
,
>
(
webSocket
:
ThisWebSocket
,
...
params
:
WebSocketConnectParams
<
NoInfer
<
ThisWebSocket
>
,
WebSocketClass
>
,
)
=>
Promise
<
ClientWebSocket
<
NoInfer
<
ThisWebSocket
>
,
NoInfer
<
WebSocketClass
>
>
,
>
Used to connect to an individual web socket from
ApiTestSuite
.
Type Parameters
Api
extends
Readonly
<
ApiImplementation
>
Type Declaration
<
const
ThisWebSocket
extends
WebSocketDefinition
&
{
path
:
keyof
Api
[
"definition"
]
[
"webSockets"
]
}
,
WebSocketClass
extends
CommonWebSocket
,
>
(
webSocket
:
ThisWebSocket
,
...
params
:
WebSocketConnectParams
<
NoInfer
<
ThisWebSocket
>
,
WebSocketClass
>
,
)
:
Promise
<
ClientWebSocket
<
NoInfer
<
ThisWebSocket
>
,
NoInfer
<
WebSocketClass
>
>
>
Type Parameters
const
ThisWebSocket
extends
WebSocketDefinition
&
{
path
:
keyof
Api
[
"definition"
]
[
"webSockets"
]
}
WebSocketClass
extends
CommonWebSocket
Parameters
webSocket
:
ThisWebSocket
...
params
:
WebSocketConnectParams
<
NoInfer
<
ThisWebSocket
>
,
WebSocketClass
>
Returns
Promise
<
ClientWebSocket
<
NoInfer
<
ThisWebSocket
>
,
NoInfer
<
WebSocketClass
>
>
>
Package
@rest-vir/host
Settings
Member Visibility
Protected
Inherited
Theme
OS
Light
Dark
rest-vir - v2.2.0
Loading...
Used to connect to an individual web socket from ApiTestSuite.