Back to Qwik

Middleware.Node.Api

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

1.7.11.7 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

/// <reference types="node" />

import type { ClientConn } from '@builder.io/qwik-city/middleware/request-handler';
import type { Http2ServerRequest } from 'node:http2';
import type { IncomingMessage } from 'node:http';
import type { ServerRenderOptions } from '@builder.io/qwik-city/middleware/request-handler';
import type { ServerResponse } from 'node:http';

// @public (undocumented)
export function createQwikCity(opts: QwikCityNodeRequestOptions): {
    router: (req: IncomingMessage | Http2ServerRequest, res: ServerResponse, next: NodeRequestNextFunction) => Promise<void>;
    notFound: (req: IncomingMessage | Http2ServerRequest, res: ServerResponse, next: (e: any) => void) => Promise<void>;
    staticFile: (req: IncomingMessage | Http2ServerRequest, res: ServerResponse, next: (e?: any) => void) => Promise<void>;
};

// @public (undocumented)
export interface NodeRequestNextFunction {
    // (undocumented)
    (err?: any): void;
}

// @public (undocumented)
export interface PlatformNode {
    // (undocumented)
    incomingMessage?: IncomingMessage | Http2ServerRequest;
    // (undocumented)
    node?: string;
    // (undocumented)
    ssr?: true;
}

// @public (undocumented)
export interface QwikCityNodeRequestOptions extends ServerRenderOptions {
    getClientConn?: (req: IncomingMessage | Http2ServerRequest) => ClientConn;
    getOrigin?: (req: IncomingMessage | Http2ServerRequest) => string | null;
    // @deprecated (undocumented)
    origin?: string;
    static?: {
        root?: string;
        cacheControl?: string;
    };
}

// (No @packageDocumentation comment for this package)