For AI agents: the complete documentation index is available at /llms.txt, the full documentation bundle is available at /llms-full.txt, and this page is available as Markdown at /api/rspeedy.server.md.
This is the dev preview website. Check out the document at lynxjs.org

Home > @lynx-js/rspeedy > Server

Server interface

The Server option changes the behavior of dev-server.

Signature:

export interface Server 

Properties

Property

Modifiers

Type

Description

base?

string | undefined

(Optional) Configure the base path of the server.

compress?

boolean | CompressOptions | undefined

(Optional) Configure whether to enable gzip compression for static assets served by the dev server or preview server.

cors?

ServerConfig['cors'] | undefined

(Optional) Configure CORS for the dev server or preview server.

headers?

Record<string, string | string[]> | undefined

(Optional) Adds headers to all responses.

host?

string | undefined

(Optional) Specify the host that the Rspeedy Server listens to.

port?

number | undefined

(Optional) Specify the port that the Rspeedy Server listens to.

proxy?

ProxyConfig | undefined

(Optional) Configure proxy rules for the dev server or preview server to proxy requests to the specified service.

strictPort?

boolean | undefined

(Optional) When a port is occupied, Rspeedy will automatically increment the port number until an available port is found.