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

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_HEADERHOST_HEADERをそれぞれX-Forwarded-ProtoX-Forwarded-Hostに指定して、デフォルトの動作を上書きできます。

origin?

string

(任意)

static?

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

(任意) 静的ファイルを提供するためのオプション

このセクションを編集