Vite for Gradle • opensavvy.gradle.vite.base.config • ProxyOptions

ProxyOptions

data class ProxyOptions(val url: String, val target: String, val changeOrigin: Boolean, val ws: Boolean, val replacePrefixBy: String?) : Serializable

Configures the proxies started by the Vite development server.

Example

vite {
    server {
        proxy("/foo", "http://localhost:4567")
    }
}

External resources

• Official documentation

See also

• ViteServerConfig.proxy

Constructors

ProxyOptions

constructor(url: String, target: String, changeOrigin: Boolean, ws: Boolean, replacePrefixBy: String?)

Properties

changeOrigin

val changeOrigin: Boolean

Changes the origin of the host header to the target URL.

replacePrefixBy

val replacePrefixBy: String?

A path section that replaces the captured url.

target

val target: String

The URL that the proxy should redirect to.

url

val url: String

The path that should be intercepted by the proxy.

ws

val ws: Boolean

true to proxy WebSockets.