Rspeedy logoRspeedy logo
Rspeedy
Guide
APIs
Blog
Contribute
Guide
APIs
Blog
Contribute

Home > @lynx-js/rspeedy > Server

Server interface

The Server option changes the behavior of dev-server.

Signature:

export interface Server

Properties

PropertyModifiersTypeDescription
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.

Default: true

See Rsbuild - server.compress for details.

cors?ServerConfig['cors'] | undefined

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

- Set to an object to enable CORS with the specified options.

- Set to true to enable CORS with the default options (allows all origins, not recommended).

- Set to false to disable CORS.

See Rsbuild - server.cors for details.

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.

Set strictPort to true and Rspeedy will throw an exception when the port is occupied.

Except as otherwise noted, this work is licensed under a Creative Commons Attribution 4.0 International License, and code samples are licensed under the Apache License 2.0.