createRelay - API reference

API reference › @evolu/nodejs › createRelay

function createRelay(
  __namedParameters: NodeJsRelayConfig,
): Task<Relay, never, RelayDeps>;

Defined in: packages/nodejs/src/local-first/Relay.ts:76

Creates an Evolu Relay server resource using Node.js.

Use createRelayDeps to create dependencies for better-sqlite3, or provide a custom SQLite driver implementation.

Example

import { assertType, Port, type Task } from "@evolu/common";
import type { Relay } from "@evolu/common/local-first";
import { createRelay, type RelayDeps } from "@evolu/nodejs";

const main = createRelay({
  port: Port.orThrow(4000),
  isOwnerWithinQuota: (_ownerId, requiredBytes) => requiredBytes <= 1024 * 1024,
});

assertType<typeof main, Task<Relay, never, RelayDeps>>();