File tree Expand file tree Collapse file tree 1 file changed +8
-1
lines changed
packages/vite-plugin-cloudflare/src Expand file tree Collapse file tree 1 file changed +8
-1
lines changed Original file line number Diff line number Diff line change @@ -26,12 +26,19 @@ import { getWarningForWorkersConfigs } from "./workers-configs";
2626import type { PluginConfig , ResolvedPluginConfig } from "./plugin-config" ;
2727import type { Unstable_RawConfig } from "wrangler" ;
2828
29+ /**
30+ * Vite plugin that enables a full-featured integration between Vite and the Cloudflare Workers runtime.
31+ *
32+ * See the [README](https://github.com/cloudflare/workers-sdk/tree/main/packages/vite-plugin-cloudflare#readme) for more details.
33+ *
34+ * @param pluginConfig An optional {@link PluginConfig} object.
35+ */
2936export function cloudflare ( pluginConfig : PluginConfig = { } ) : vite . Plugin {
3037 let resolvedPluginConfig : ResolvedPluginConfig ;
3138 let resolvedViteConfig : vite . ResolvedConfig ;
3239 let miniflare : Miniflare | undefined ;
3340
34- // this flag is used to shown the workers configs warning only once
41+ // this flag is used to show the workers configs warning only once
3542 let workersConfigsWarningShown = false ;
3643
3744 return {
You can’t perform that action at this time.
0 commit comments