createOwnerWebSocketTransport - API reference

API reference › @evolu/common › local‑first/Owner › createOwnerWebSocketTransport

function createOwnerWebSocketTransport(config: {
  ownerId: string & Brand<"Id"> & Brand<"OwnerId">;
  url: string;
}): OwnerWebSocketTransport;

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

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

import {
  assertEqual,
  createEvolu,
  createOwnerWebSocketTransport,
  testAppName,
  testAppOwner,
  testEvoluSchema,
} from "@evolu/common";

const transport = createOwnerWebSocketTransport({
  url: "wss://relay.evolu.dev",
  ownerId: testAppOwner.id,
});
const _createTodoEvolu = createEvolu(testEvoluSchema, {
  appName: testAppName,
  appOwner: testAppOwner,
  transports: [transport],
});

assertEqual(transport, {
  type: "WebSocket",
  url: `wss://relay.evolu.dev?ownerId=${testAppOwner.id}`,
});