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

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>; }

編輯此區段

NodeRequestNextFunction

export interface NodeRequestNextFunction

編輯此區段

PlatformNode

export interface PlatformNode

屬性

修飾符

類型

說明

incomingMessage？

IncomingMessage | Http2ServerRequest

（可選）

node？

string

（可選）

ssr？

true

（可選）

編輯此區段

QwikCityNodeRequestOptions

export interface QwikCityNodeRequestOptions extends ServerRenderOptions

繼承： ServerRenderOptions

屬性

修飾符

類型

說明

getClientConn？

(req: IncomingMessage | Http2ServerRequest) => ClientConn

（可選） 提供一個函數，用於返回給定請求的 ClientConn。

getOrigin？

(req: IncomingMessage | Http2ServerRequest) => string | null

（可選） 提供一個函數，用於計算服務器的來源，用於解析相對 URL 並針對 CSRF 攻擊驗證請求來源。

未指定時，默認使用 ORIGIN 環境變數（如果已設置）。

如果未設置 ORIGIN，則從傳入請求中獲取，這不建議用於生產環境。您可以分別將 PROTOCOL_HEADER、HOST_HEADER 指定為 X-Forwarded-Proto 和 X-Forwarded-Host，以覆蓋默認行為。

origin？

string

（可選）

static？

{ root?: string; cacheControl?: string; }

（可選） 服務靜態文件的選項

編輯此區段