Class TestWsConnection

TestWsConnection

Live WebSocket connection wrapper with assertion helpers for testing.

Example

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

Index

Constructors

constructor

new TestWsConnection(ws: WebSocket): TestWsConnection
Parameters
- ws: WebSocket
Returns TestWsConnection
- Defined in packages/testing/src/core/ws/test-ws-connection.ts:23

Accessors

raw

get raw(): WebSocket
Access the raw Cloudflare WebSocket

Returns WebSocket
- Defined in packages/testing/src/core/ws/test-ws-connection.ts:126

Methods

assertClosed

assertClosed(expectedCode?: number, timeout?: number): Promise<void>
Assert that the connection closes, optionally with an expected code
Parameters
- OptionalexpectedCode: number
- timeout: number = 5000
Returns Promise<void>
- Defined in packages/testing/src/core/ws/test-ws-connection.ts:116

assertMessage

assertMessage(expected: string, timeout?: number): Promise<void>
Assert that the next message equals the expected value
Parameters
- expected: string
- timeout: number = 5000
Returns Promise<void>
- Defined in packages/testing/src/core/ws/test-ws-connection.ts:107

close

close(code?: number, reason?: string): void
Close the WebSocket connection
Parameters
- Optionalcode: number
- Optionalreason: string
Returns void
- Defined in packages/testing/src/core/ws/test-ws-connection.ts:52

send

send(data: string | ArrayBuffer | Uint8Array<ArrayBufferLike>): void
Send a message through the WebSocket
Parameters
- data: string | ArrayBuffer | Uint8Array<ArrayBufferLike>
Returns void
- Defined in packages/testing/src/core/ws/test-ws-connection.ts:45

waitForClose

waitForClose(timeout?: number): Promise<{ code?: number; reason?: string }>
Wait for the connection to close
Parameters
- timeout: number = 5000
Returns Promise<{ code?: number; reason?: string }>
- Defined in packages/testing/src/core/ws/test-ws-connection.ts:83

waitForMessage

waitForMessage(timeout?: number): Promise<string | ArrayBuffer>
Wait for the next message, returning its data
Parameters
- timeout: number = 5000
Returns Promise<string | ArrayBuffer>
- Defined in packages/testing/src/core/ws/test-ws-connection.ts:59

Class TestWsConnection

Example

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

Returns TestWsConnection

Accessors

raw

Returns WebSocket

Methods

assertClosed

Parameters

Returns Promise<void>

assertMessage

Parameters

Returns Promise<void>

close

Parameters

Returns void

send

Parameters

Returns void

waitForClose

Parameters

Returns Promise<{ code?: number; reason?: string }>

waitForMessage

Parameters

Returns Promise<string | ArrayBuffer>

Settings

On This Page