node

createQwikCity

Warning: This API is now obsolete.

Use createQwikRouter instead. Will be removed in V3

createQwikCity: typeof createQwikRouter;

Edit this section

createQwikRouter

export declare function createQwikRouter(
  opts: QwikRouterNodeRequestOptions | 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>;
};

Parameter	Type	Description
opts	QwikRouterNodeRequestOptions \| QwikCityNodeRequestOptions

Returns:

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

Edit this section

NodeRequestNextFunction

export interface NodeRequestNextFunction

Edit this section

PlatformNode

export interface PlatformNode

Property	Type	Description
incomingMessage?	IncomingMessage \| Http2ServerRequest	(Optional)
node?	string	(Optional)
ssr?	true	(Optional)

Edit this section

QwikCityNodeRequestOptions

Warning: This API is now obsolete.

Use QwikRouterNodeRequestOptions instead. Will be removed in V3

export type QwikCityNodeRequestOptions = QwikRouterNodeRequestOptions;

References: QwikRouterNodeRequestOptions

Edit this section

QwikRouterNodeRequestOptions

export interface QwikRouterNodeRequestOptions extends ServerRenderOptions

Extends: ServerRenderOptions

Property	Type	Description
getClientConn?	(req: IncomingMessage \| Http2ServerRequest) => ClientConn	(Optional) Provide a function that returns a `ClientConn` for the given request.
getOrigin?	(req: IncomingMessage \| Http2ServerRequest) => string \| null	(Optional) Provide a function that computes the origin of the server, used to resolve relative URLs and validate the request origin against CSRF attacks. When not specified, it defaults to the `ORIGIN` environment variable (if set). If `ORIGIN` is not set, it's derived from the incoming request, which is not recommended for production use. You can specify the `PROTOCOL_HEADER`, `HOST_HEADER` to `X-Forwarded-Proto` and `X-Forwarded-Host` respectively to override the default behavior.
origin?	string	(Optional)
static?	{ root?: string; cacheControl?: string; }	(Optional) Options for serving static files

Edit this section