feat: expose preview method (#5014)

vitejs · Sep 24, 2021 · 9885656 · 9885656
1 parent ac55755
commit 9885656
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 0 deletions.
diff --git a/packages/vite/src/node/index.ts b/packages/vite/src/node/index.ts
@@ -1,5 +1,6 @@
 export * from './config'
 export { createServer, searchForWorkspaceRoot } from './server'
+export { preview } from './preview'
 export { build } from './build'
 export { optimizeDeps } from './optimizer'
 export { send } from './server/send'

diff --git a/packages/vite/src/node/preview.ts b/packages/vite/src/node/preview.ts
@@ -16,6 +16,12 @@ import { proxyMiddleware } from './server/middlewares/proxy'
 import { printServerUrls } from './logger'
 import { resolveHostname } from './utils'
 
+/**
+ * Starts the Vite server in preview mode, to simulate a production deployment
+ * @param config - the resolve Vite config
+ * @param serverOptions - what host and port to use
+ * @experimental
+ */
 export async function preview(
   config: ResolvedConfig,
   serverOptions: Pick<ServerOptions, 'port' | 'host'>