Class TestWsRequest

TestWsRequest

Builder for WebSocket upgrade requests. Follows the TestHttpRequest pattern.

Example

const ws = await module.ws('/ws/chat').connect()
ws.send('hello')
await ws.assertMessage('echo:hello')
ws.close()

Example: Authenticated WebSocket

const ws = await module.ws('/ws/chat').actingAs({ id: user.id }).connect()

Index

Constructors

Methods

actingAs connect withHeaders withLocale

Constructors

constructor

new TestWsRequest(path: string, module: TestingModule): TestWsRequest
Parameters
- path: string
- module: TestingModule
Returns TestWsRequest
- Defined in packages/testing/src/core/ws/test-ws-request.ts:32

Methods

actingAs

actingAs(user: { id: string }): this
Authenticate the WebSocket connection as a specific user
Parameters
- user: { id: string }
Returns this
- Defined in packages/testing/src/core/ws/test-ws-request.ts:60

connect

connect(): Promise<TestWsConnection>
Send the upgrade request and return a live WebSocket connection

Returns Promise<TestWsConnection>
- Defined in packages/testing/src/core/ws/test-ws-request.ts:68

withHeaders

withHeaders(headers: Record<string, string>): this
Add custom headers to the upgrade request
Parameters
- headers: Record<string, string>
Returns this
- Defined in packages/testing/src/core/ws/test-ws-request.ts:40

withLocale

withLocale(locale: string, strategy?: DetectionStrategy): this
Set the locale for this WebSocket connection. If strategy is not provided, resolves from the module's I18n configuration.
Parameters
- locale: string
- Optionalstrategy: DetectionStrategy
Returns this
- Defined in packages/testing/src/core/ws/test-ws-request.ts:51