← Cloudflare Workers / workers / vite-plugin / reference

API

cloudflare plugin by měl být zahrnutý v konfiguraci Vite plugins pole:

import { defineConfig } from "vite";
import { cloudflare } from "@cloudflare/vite-plugin";

export default defineConfig({
	plugins: [cloudflare()],
});

Přijímá volitelný PluginConfig .

• configPath string volitelné

  Volitelná cesta ke konfiguračnímu souboru vstupního Workeru.

  U vstupního Workeru plugin určuje cestu ke konfiguraci v tomto pořadí:

  1. configPath
  2. CLOUDFLARE_VITE_WRANGLER_CONFIG_PATH (obvykle nastavené frameworkem nebo jiným externím nástrojem)
  3. wrangler.jsonc, wrangler.json, nebo wrangler.toml v kořenovém adresáři vaší aplikace

  To platí v vite dev a vite build.

  Více informací o konfiguraci Workeru najdete v Konfigurace.

• config WorkerConfigCustomizer<true> volitelné

  Programově přizpůsobte nebo přepište konfiguraci Workeru. Přijímá částečný konfigurační objekt nebo funkci, která obdrží aktuální konfiguraci.

  Uplatní se po načtení konfiguračního souboru. Použijte ho k přepsání hodnot, úpravě stávající konfigurace nebo k definování Workers přímo v kódu.

  Viz Programová konfigurace s podrobnostmi.

• viteEnvironment { name?: string; childEnvironments?: string[] } volitelné

  Volitelné možnosti prostředí Vite. Ve výchozím nastavení je název prostředí názvem Workeru s - znaků nahrazených _. Nastavení názvu zde toto přepíše. Typickým případem použití je nastavení viteEnvironment: { name: "ssr" } pro použití Workeru na prostředí SSR.

  childEnvironments možnost slouží k podpoře React Server Components pomocí @vitejs/plugin-rsc ↗ a frameworky, které na něm stavějí. Toto umožňuje vkládat další prostředí s vlastními grafy modulů do jednoho Workeru.

  Viz Vite Environments s dalšími informacemi.

• persistState boolean | { path: string } volitelné

  Volitelné přepsání pro perzistenci stavu. Ve výchozím nastavení se stav ukládá do .wrangler/state. Vlastní path lze zadat, nebo lze perzistenci vypnout nastavením hodnoty na false.

• inspectorPort number | false volitelné

  Volitelné přepsání pro ladění vašich Workers. Ve výchozím nastavení je ladicí inspektor povolený a naslouchá na portu 9229. Můžete zadat vlastní port, případně jej nastavit na false vypne ladicí inspector.

  Viz Ladění s dalšími informacemi.

• tunnel boolean | { name?: string; autoStart?: boolean } volitelné

  Zpřístupněte svůj lokální vývojový server přes Cloudflare Tunnel.

  Zadejte objekt pro konfiguraci pojmenovaného tunelu nebo řízení jeho automatického spouštění. Stiskněte t + Enter pro spuštění nebo ukončení tunelu. Nastavte tunnel.autoStart na true pokud chcete, aby se tunel otevřel při spuštění Vite.

  vite.config.js

  import { defineConfig } from "vite";
  import { cloudflare } from "@cloudflare/vite-plugin";
  
  export default defineConfig({
  	plugins: [
  		cloudflare({
  			tunnel: { name: "my-tunnel" },
  		}),
  	],
  });

  vite.config.ts

  import { defineConfig } from "vite";
  import { cloudflare } from "@cloudflare/vite-plugin";
  
  export default defineConfig({
  	plugins: [
  		cloudflare({
  			tunnel: { name: "my-tunnel" },
  		}),
  	],
  });

  Viz Sdílení místního vývojového serveru s dalšími informacemi.

• auxiliaryWorkers Array<AuxiliaryWorkerConfig> volitelné

  Volitelné pole pomocných Workers. Pomocní Workers jsou další Workers, které se používají jako součást vaší aplikace. Můžete použít service bindings pro volání pomocných Workerů z vašeho hlavního (vstupního) Workeru. Všechny požadavky se směrují přes váš vstupní Worker. Během sestavení se každý Worker uloží do samostatného podadresáře dist.

• remoteBindings boolean volitelné

  Zda vzdálené bindings by mělo být povoleno. Výchozí hodnota je true.

Pomocní Workers vyžadují configPath, config možnost, nebo obě. CLOUDFLARE_VITE_WRANGLER_CONFIG_PATH platí pouze pro vstupní Worker. Pomocné Workery tuto proměnnou prostředí nepoužívají. Pokud pro pomocný Worker používáte konfigurační soubor, nastavte configPath explicitně.

• configPath string volitelné

  Cesta ke konfiguračnímu souboru vašeho Workeru. Toto pole je povinné, pokud není zadáno config je zadáno.

  Více informací o konfiguraci Workeru najdete v Konfigurace.

• config WorkerConfigCustomizer<false> volitelné

  Programově přizpůsobte nebo přepište konfiguraci Workeru. Pokud se použije bez configPath, to umožňuje definovat pomocné Workery zcela v kódu.

  Viz Programová konfigurace pro příklady použití.

• viteEnvironment { name?: string; childEnvironments?: string[] } volitelné

  Volitelné možnosti prostředí Vite. Ve výchozím nastavení je název prostředí názvem Workeru s - znaků nahrazených _. Nastavení názvu zde toto přepíše.

  childEnvironments možnost slouží k podpoře React Server Components pomocí @vitejs/plugin-rsc ↗ a frameworky, které na něm stavějí. Toto umožňuje vkládat další prostředí s vlastními grafy modulů do jednoho Workeru.

  Viz Vite Environments s dalšími informacemi.