Skip to content

API

ogygia/server

The SvelteKit server handle.

On this page

Auto-generated from the package’s own .d.ts on every build — signatures, JSDoc, and examples straight from the source.

import { … } from 'ogygia/server';

Exports handle · ogygiaTransport · OgygiaHandleOptions

handle

function

function handle(options?: OgygiaHandleOptions): Handle;

ogygiaTransport

const

const ogygiaTransport: {
  Region: {
    encode(value: unknown): false | EncodedRegion;
    decode(raw: EncodedRegion): {
      html?: string;
      hydrateMargin?: string;
      hydrate?: string;
      [REGION_BRAND]: boolean;
      kind: "deferred";
      id: string;
      props: Record<string, unknown>;
      url: string;
      module: string;
    };
  };
}

OgygiaHandleOptions

interface

Options for handle.

interface OgygiaHandleOptions {/*…*/}

OgygiaHandleOptions.endpoint

Path (relative to Kit base) the handle serves. Default is the clash-safe island-emoji route (/__ogygia__). Must start with /.

endpoint?: string;