API › @builder.io/qwik-city/middleware/node
createQwikCity
export declare 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>;
};
パラメータ
型
説明
opts
{ 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>; }
NodeRequestNextFunction
export interface NodeRequestNextFunction
PlatformNode
export interface PlatformNode
プロパティ
修飾子
型
説明
IncomingMessage | Http2ServerRequest
(任意)
string
(任意)
true
(任意)
QwikCityNodeRequestOptions
export interface QwikCityNodeRequestOptions extends ServerRenderOptions
拡張: ServerRenderOptions
プロパティ
修飾子
型
説明
(req: IncomingMessage | Http2ServerRequest) => ClientConn
(任意) 指定されたリクエストに対してClientConn
を返す関数を提供します。
(req: IncomingMessage | Http2ServerRequest) => string | null
(任意) サーバーのオリジンを計算する関数を提供します。これは、相対URLを解決し、CSRF攻撃に対してリクエストのオリジンを検証するために使用されます。
指定されていない場合、デフォルトでORIGIN
環境変数(設定されている場合)が使用されます。
ORIGIN
が設定されていない場合は、受信リクエストから派生しますが、本番環境での使用はお勧めできません。 PROTOCOL_HEADER
、HOST_HEADER
をそれぞれX-Forwarded-Proto
、X-Forwarded-Host
に指定して、デフォルトの動作を上書きできます。
string
(任意)
{ root?: string; cacheControl?: string; }
(任意) 静的ファイルを提供するためのオプション