Get Started

Transports

Transports provide access to runtime-specific APIs.

By default, Zeta uses createFetchTransport. It detects your runtime and provides a minimal transport that supports Bun and Deno.

Runtime-specific API Access

The default fetch transport not provide access to runtime-specific APIs. For example, in Bun, you use the server arg to setup websockets or get the request IP address:

Bun.serve({
  fetch: (request, server) => {
    const ip = server.requestIP(request);
    // ...
  },
});

To access the same object, you need to provide a custom transport then transport-specific APIs, then use the transports helper functions, likes getBunServer:

import { createApp } from "@aklinker1/zeta";
import { createBunTransport, getBunServer } from "@aklinker1/zeta/transports/bun-transport";

const app = createApp({
  transport: createBunTransport(),
}).get(({ request }) => {
  const server = getBunServer(request);
  const ip = server.requestIP(request);
  // ...
});

Alternatively, you can use the plugin to decorate your context directly:

import { createApp } from "@aklinker1/zeta";
import { createBunTransport, bunServerPlugin } from "@aklinker1/zeta/transports/bun-transport";

const app = createApp({
  transport: createBunTransport(),
})
  .use(bunServerPlugin)
  .get(({ server }) => {
    const ip = server.requestIP(request);
    // ...
  });

You only have to add the transport once to your top-level app, even if you're using these utils in child-apps.

Transport Options

Some transports also support passing custom options:

import { createBunTransport } from "@aklinker1/zeta/transports/bun-transport";

const transport = createBunTransport({
  websocket: {
    // ...
  },
});

const app = createApp({
  transport,
});