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

Function: createWebSocketTransportConfig()

function createWebSocketTransportConfig(
  __namedParameters,
): WebSocketTransportConfig;

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

Creates a WebSocketTransportConfig for the given relay URL and OwnerId.

Example

const transport = createWebSocketTransportConfig({
  relayUrl: "wss://relay.evolu.dev",
  ownerId: owner.id,
});
// Result: { type: "WebSocket", url: "wss://relay.evolu.dev?ownerId=..." }

Parameters

Parameter	Type
`__namedParameters`	{ `ownerId`: `string` & `Brand`<`"Id"`> & `Brand`<`"OwnerId"`>; `relayUrl`: `string`; }
`__namedParameters.ownerId`	`string` & `Brand`<`"Id"`> & `Brand`<`"OwnerId"`>
`__namedParameters.relayUrl`	`string`

Returns

WebSocketTransportConfig