Class TestSseRequest

TestSseRequest

Builder for SSE connection requests. Follows the TestWsRequest pattern.

Example

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

Example: Authenticated SSE

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

Index

Constructors

Methods

actingAs connect withHeaders withLocale

Constructors

constructor

new TestSseRequest(path: string, module: TestingModule): TestSseRequest
Parameters
- path: string
- module: TestingModule
Returns TestSseRequest
- Defined in packages/testing/src/core/sse/test-sse-request.ts:31

Methods

actingAs

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

connect

connect(): Promise<TestSseConnection>
Send the request and return a live SSE connection

Returns Promise<TestSseConnection>
- Defined in packages/testing/src/core/sse/test-sse-request.ts:67

withHeaders

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

withLocale

withLocale(locale: string, strategy?: DetectionStrategy): this
Set the locale for this SSE 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/sse/test-sse-request.ts:50