docs: add documentation for preview method

vitejs · Sep 22, 2021 · c293000 · c293000
1 parent 95fe350
commit c293000
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/packages/vite/src/node/preview.ts b/packages/vite/src/node/preview.ts
@@ -16,6 +16,11 @@ 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
+ */
 export async function preview(
   config: ResolvedConfig,
   serverOptions: Pick<ServerOptions, 'port' | 'host'>