Vite入门教程 Vite HMR API ViteDevServer

2024-02-25 开发教程 Vite入门教程 匿名 2
interface ViteDevServer {
/**
* 被解析的 Vite 配置对象
*/
config: ResolvedConfig
/**
* 一个 connect 应用实例
* - 可以用于将自定义中间件附加到开发服务器。
* - 还可以用作自定义http服务器的处理函数。
或作为中间件用于任何 connect 风格的 Node.js 框架。
*
* https://github.com/senchalabs/connect#use-middleware
*/
middlewares: Connect.Server
/**
* 本机 node http 服务器实例
*/
httpServer: http.Server | null
/**
* chokidar 监听器实例
* https://github.com/paulmillr/chokidar#api
*/
watcher: FSWatcher
/**
* web socket 服务器,带有 `send(payload)` 方法。
*/
ws: WebSocketServer
/**
* Rollup 插件容器,可以针对给定文件运行插件钩子。
*/
pluginContainer: PluginContainer
/**
* 跟踪导入关系、url 到文件映射和 hmr 状态的模块图。
*/
moduleGraph: ModuleGraph
/**
* 以代码方式解析、加载和转换 url 并获取结果
* 而不需要通过 http 请求管道。
*/
transformRequest(
url: string,
options?: TransformOptions
): Promise<TransformResult | null>
/**
* 应用 Vite 内建 HTML 转换和任意插件 HTML 转换
*/
transformIndexHtml(url: string, html: string): Promise<string>
/**
* 加载一个给定的 URL 作为 SSR 的实例化模块
*/
ssrLoadModule(
url: string,
options?: { isolated?: boolean }
): Promise<Record<string, any>>
/**
* 解决 ssr 错误堆栈信息
*/
ssrFixStacktrace(e: Error): void
/**
* 启动服务器
*/
listen(port?: number, isRestart?: boolean): Promise<ViteDevServer>
/**
* 重启服务器
*
* @param forceOptimize - 强制优化器重新大伯啊,和命令行内使用 --force 一致
*/
restart(forceOptimize?: boolean): Promise<void>
/**
* 停止服务器
*/
close(): Promise<void>
}