API reference / @evolu/common / local-first / createOwnerWebSocketTransport

Function: createOwnerWebSocketTransport()

function createOwnerWebSocketTransport(config): OwnerWebSocketTransport;

Defined in: packages/common/src/local-first/Owner.ts:358

Creates an OwnerWebSocketTransport for the given relay URL and OwnerId.

The URL must be a WebSocket base URL without query parameters or fragments (e.g., wss://relay.evolu.dev, not wss://relay.evolu.dev?foo=bar). The function appends the ownerId as a query parameter.

Example

// Create transport "wss://relay.evolu.dev?ownerId=..."
const transport = createOwnerWebSocketTransport({
  url: "wss://relay.evolu.dev",
  ownerId: owner.id,
});

// Use with createEvolu
const evolu = createEvolu(deps)(Schema, {
  transports: [transport],
});

Parameters

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

Returns

OwnerWebSocketTransport