Class TestSseConnection

TestSseConnection

Live SSE connection wrapper with assertion helpers for testing.

Example

const sse = await module.sse('/streaming/sse').connect()
await sse.assertEvent({ event: 'message', data: 'hello', id: '1' })
await sse.waitForEnd()

Index

Constructors

constructor

new TestSseConnection(response: Response): TestSseConnection
Parameters
- response: Response
Returns TestSseConnection
- Defined in packages/testing/src/core/sse/test-sse-connection.ts:31

Accessors

raw

get raw(): Response
Access the raw Response

Returns Response
- Defined in packages/testing/src/core/sse/test-sse-connection.ts:151

Methods

assertEvent

assertEvent(expected: Partial<TestSseEvent>, timeout?: number): Promise<void>
Assert that the next event matches the expected partial shape
Parameters
- expected: Partial<TestSseEvent>
- timeout: number = 5000
Returns Promise<void>
- Defined in packages/testing/src/core/sse/test-sse-connection.ts:126

assertEventData

assertEventData(expected: string, timeout?: number): Promise<void>
Assert that the next event's data matches the expected string
Parameters
- expected: string
- timeout: number = 5000
Returns Promise<void>
- Defined in packages/testing/src/core/sse/test-sse-connection.ts:134

assertJsonEventData

assertJsonEventData<T>(expected: T, timeout?: number): Promise<void>
Assert that the next event's data is JSON matching the expected value
Type Parameters
- T
Parameters
- expected: T
- timeout: number = 5000
Returns Promise<void>
- Defined in packages/testing/src/core/sse/test-sse-connection.ts:142

collectEvents

collectEvents(timeout?: number): Promise<TestSseEvent[]>
Collect all remaining events until the stream ends
Parameters
- timeout: number = 5000
Returns Promise<TestSseEvent[]>
- Defined in packages/testing/src/core/sse/test-sse-connection.ts:88

waitForEnd

waitForEnd(timeout?: number): Promise<void>
Wait for the stream to end
Parameters
- timeout: number = 5000
Returns Promise<void>
- Defined in packages/testing/src/core/sse/test-sse-connection.ts:66

waitForEvent

waitForEvent(timeout?: number): Promise<TestSseEvent>
Wait for the next SSE event
Parameters
- timeout: number = 5000
Returns Promise<TestSseEvent>
- Defined in packages/testing/src/core/sse/test-sse-connection.ts:38

Class TestSseConnection

Example

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

Returns TestSseConnection

Accessors

raw

Returns Response

Methods

assertEvent

Parameters

Returns Promise<void>

assertEventData

Parameters

Returns Promise<void>

assertJsonEventData

Type Parameters

Parameters

Returns Promise<void>

collectEvents

Parameters

Returns Promise<TestSseEvent[]>

waitForEnd

Parameters

Returns Promise<void>

waitForEvent

Parameters

Returns Promise<TestSseEvent>

Settings

On This Page