Back to Qwik

Middleware.Deno.Api

packages/qwik-city/src/middleware/deno/middleware.deno.api.md

1.7.11.3 KB
Original Source

API Report File for "@builder.io/qwik-city"

Do not edit this file. It is a report generated by API Extractor.

ts

import type { ClientConn } from '@builder.io/qwik-city/middleware/request-handler';
import type { ServerRenderOptions } from '@builder.io/qwik-city/middleware/request-handler';

// @public (undocumented)
export function createQwikCity(opts: QwikCityDenoOptions): {
    router: (request: Request, info: ServeHandlerInfo) => Promise<Response | null>;
    notFound: (request: Request) => Promise<Response>;
    staticFile: (request: Request) => Promise<Response | null>;
};

// @public (undocumented)
export interface NetAddr {
    // (undocumented)
    hostname: string;
    // (undocumented)
    port: number;
    // (undocumented)
    transport: 'tcp' | 'udp';
}

// @public (undocumented)
export interface QwikCityDenoOptions extends ServerRenderOptions {
    getClientConn?: (request: Request, info: ServeHandlerInfo) => ClientConn;
    getOrigin?: (request: Request, info?: ServeHandlerInfo) => string | null;
    static?: {
        root?: string;
        cacheControl?: string;
    };
}

// @public (undocumented)
export interface ServeHandlerInfo {
    // (undocumented)
    remoteAddr: NetAddr;
}

// (No @packageDocumentation comment for this package)