← Cloudflare Workers / workers / vite-plugin / reference

API

cloudflare плагин следует включить в plugins массив:

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

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

Принимает необязательный PluginConfig параметр.

• configPath string необязательно

  Необязательный путь к файлу конфигурации входного Worker.

  Для входного Worker плагин определяет путь к конфигурации в следующем порядке:

  1. configPath
  2. CLOUDFLARE_VITE_WRANGLER_CONFIG_PATH (обычно задаётся фреймворком или другим внешним инструментом)
  3. wrangler.jsonc, wrangler.json, или wrangler.toml в корне вашего приложения

  Это применяется в vite dev и vite build.

  Подробнее о конфигурации Worker см. в Конфигурация.

• config WorkerConfigCustomizer<true> необязательно

  Настраивает или переопределяет конфигурацию Worker программно. Принимает частичный объект конфигурации или функцию, которая получает текущую конфигурацию.

  Применяется после загрузки любого файла конфигурации. Используйте это, чтобы переопределить значения, изменить существующую конфигурацию или полностью описать Workers в коде.

  См. Программная конфигурация для получения подробностей.

• viteEnvironment { name?: string; childEnvironments?: string[] } необязательно

  Необязательные параметры окружения Vite. По умолчанию именем окружения является имя Worker с - символов, заменённых на _. Если задать имя здесь, оно переопределит это значение. Типичный пример использования: задать viteEnvironment: { name: "ssr" } чтобы применить Worker к окружению SSR.

  childEnvironments параметр нужен для поддержки React Server Components через @vitejs/plugin-rsc ↗ и фреймворков, построенных на его основе. Это позволяет встраивать дополнительные окружения с отдельными графами модулей внутри одного Worker.

  См. Окружения Vite, где это описано подробнее.

• persistState boolean | { path: string } необязательно

  Необязательный параметр для переопределения сохранения состояния. По умолчанию состояние сохраняется в .wrangler/state. Пользовательский path можно указать, либо, в качестве альтернативы, отключить сохранение, задав значение false.

• inspectorPort number | false необязательно

  Необязательный параметр для переопределения отладки Workers. По умолчанию отладочный инспектор включён и прослушивает порт 9229. Можно указать пользовательский порт или, в качестве альтернативы, установить значение false отключит инспектор отладки.

  См. Отладка, где это описано подробнее.

• tunnel boolean | { name?: string; autoStart?: boolean } необязательно

  Опубликуйте локальный dev-сервер через Cloudflare Tunnel.

  Передайте объект для настройки именованного туннеля или управления его автоматическим запуском. Нажмите t + Enter чтобы запустить или закрыть туннель. Задайте tunnel.autoStart к true если хотите, чтобы туннель открывался при запуске 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" },
  		}),
  	],
  });

  См. Общий доступ к локальному серверу разработки, где это описано подробнее.

• auxiliaryWorkers Array<AuxiliaryWorkerConfig> необязательно

  Необязательный массив вспомогательных Workers. Вспомогательными Workers называются дополнительные Workers, которые используются как часть вашего приложения. Вы можете использовать привязки к сервисам чтобы вызывать вспомогательные Workers из основного (entry) Worker. Все запросы проходят через entry Worker. Во время сборки каждый Worker выводится в отдельный подкаталог dist.

• remoteBindings boolean необязательно

  Независимо от того, удаленные привязки следует включить. По умолчанию true.

Вспомогательные Workers требуют configPath, config параметр, или оба варианта сразу. CLOUDFLARE_VITE_WRANGLER_CONFIG_PATH применяется только к entry Worker. Вспомогательные Workers не используют эту переменную окружения. Если вы используете файл конфигурации для вспомогательного Worker, задайте configPath явно.

• configPath string необязательно

  Путь к файлу конфигурации вашего Worker. Это поле обязательно, если не указано config указан.

  Подробнее о конфигурации Worker см. в Конфигурация.

• config WorkerConfigCustomizer<false> необязательно

  Настраивает или переопределяет конфигурацию Worker программно. При использовании без configPath, это позволяет полностью определять вспомогательные Workers в коде.

  См. Программная конфигурация для примеров использования.

• viteEnvironment { name?: string; childEnvironments?: string[] } необязательно

  Необязательные параметры окружения Vite. По умолчанию именем окружения является имя Worker с - символов, заменённых на _. Если задать имя здесь, оно переопределит это значение.

  childEnvironments параметр нужен для поддержки React Server Components через @vitejs/plugin-rsc ↗ и фреймворков, построенных на его основе. Это позволяет встраивать дополнительные окружения с отдельными графами модулей внутри одного Worker.

  См. Окружения Vite, где это описано подробнее.