API reference / @evolu/common / Evolu/Owner / WebSocketTransportConfig

Interface: WebSocketTransportConfig

Defined in: packages/common/src/Evolu/Owner.ts:207

WebSocket transport configuration for relay connections.

Use createWebSocketTransportConfig to create a properly formatted URL with OwnerId. The relay uses parseOwnerIdFromUrl to extract the OwnerId from the query string.

Authentication and Error Handling

When a relay rejects a connection (invalid OwnerId, unauthorized owner, or server error), the browser WebSocket API does not expose the specific HTTP status code or reason - it only reports a generic connection failure. The client automatically retries with exponential backoff and jitter, eventually succeeding once the configuration or server issue is resolved.

Legitimate clients will be properly configured with valid credentials, so automatic retry is appropriate.

See

• createWebSocketTransportConfig
• parseOwnerIdFromUrl

Properties

Property	Modifier	Type	Defined in
type	readonly	"WebSocket"	packages/common/src/Evolu/Owner.ts:208
url	readonly	string	packages/common/src/Evolu/Owner.ts:209