Interface ServerOptions

interface ServerOptions {
    cors?: boolean | CorsOptions;
    fs?: FileSystemServeOptions;
    headers?: OutgoingHttpHeaders;
    hmr?: boolean | HmrOptions;
    host?: string | boolean;
    https?: ServerOptions;
    middlewareMode?: boolean | {
        server: Server<typeof IncomingMessage, typeof ServerResponse>;
    };
    open?: string | boolean;
    origin?: string;
    port?: number;
    preTransformRequests?: boolean;
    proxy?: Record<string, string | ProxyOptions>;
    sourcemapIgnoreList?: false | ((sourcePath, sourcemapPath) => boolean);
    strictPort?: boolean;
    warmup?: {
        clientFiles?: string[];
        ssrFiles?: string[];
    };
    watch?: null | WatchOptions;
}

Hierarchy (view full)

Properties

cors? fs? headers? hmr? host? https? middlewareMode? open? origin? port? preTransformRequests? proxy? sourcemapIgnoreList? strictPort? warmup? watch?

Properties

Optional cors

cors?: boolean | CorsOptions

Configure CORS for the dev server. Uses https://github.com/expressjs/cors. Set to true to allow all methods from any origin, or configure separately using an object.

Optional fs

fs?: FileSystemServeOptions

Options for files served via '/@fs/'.

Optional headers

headers?: OutgoingHttpHeaders

Specify server response headers.

Optional hmr

hmr?: boolean | HmrOptions

Configure HMR-specific options (port, host, path & protocol)

Optional host

host?: string | boolean

Specify which IP addresses the server should listen on. Set to 0.0.0.0 to listen on all addresses, including LAN and public addresses.

Optional https

https?: ServerOptions

Enable TLS + HTTP/2. Note: this downgrades to TLS only when the proxy option is also used.

Optional middlewareMode

middlewareMode?: boolean | {
    server: Server<typeof IncomingMessage, typeof ServerResponse>;
}

Create Vite dev server to be used as a middleware in an existing server

Type declaration

Default

false

Optional open

open?: string | boolean

Open browser window on startup

Optional origin

origin?: string

Origin for the generated asset URLs.

Example

`http://127.0.0.1:8080`

Optional port

port?: number

Specify server port. Note if the port is already being used, Vite will automatically try the next available port so this may not be the actual port the server ends up listening on.

Optional preTransformRequests

preTransformRequests?: boolean

Pre-transform known direct imports

Default

true

Optional proxy

proxy?: Record<string, string | ProxyOptions>

Configure custom proxy rules for the dev server. Expects an object of { key: options } pairs. Uses http-proxy. Full options here.

Example vite.config.js:

module.exports = {
  proxy: {
    // string shorthand: /foo -> http://localhost:4567/foo
    '/foo': 'http://localhost:4567',
    // with options
    '/api': {
      target: 'http://jsonplaceholder.typicode.com',
      changeOrigin: true,
      rewrite: path => path.replace(/^/api/, '')
    }
  }
}

Optional sourcemapIgnoreList

sourcemapIgnoreList?: false | ((sourcePath, sourcemapPath) => boolean)

Whether or not to ignore-list source files in the dev server sourcemap, used to populate the x_google_ignoreList source map extension.

By default, it excludes all paths containing node_modules. You can pass false to disable this behavior, or, for full control, a function that takes the source path and sourcemap path and returns whether to ignore the source path.

Type declaration

    • (sourcePath, sourcemapPath): boolean

    • Parameters

      • sourcePath: string
      • sourcemapPath: string

      Returns boolean

Optional strictPort

strictPort?: boolean

If enabled, vite will exit if specified port is already in use

Optional warmup

warmup?: {
    clientFiles?: string[];
    ssrFiles?: string[];
}

Warm-up files to transform and cache the results in advance. This improves the initial page load during server starts and prevents transform waterfalls.

Type declaration

  • Optional clientFiles?: string[]

    The files to be transformed and used on the client-side. Supports glob patterns.

  • Optional ssrFiles?: string[]

    The files to be transformed and used in SSR. Supports glob patterns.

Optional watch

watch?: null | WatchOptions

chokidar watch options or null to disable FS watching https://github.com/paulmillr/chokidar#api

Settings

Member Visibility

Theme

On This Page

corsfsheadershmrhosthttpsmiddlewareModeopenoriginportpreTransformRequestsproxysourcemapIgnoreListstrictPortwarmupwatch