← Cloudflare Workers / workers / configuration

Metadata vícedílného nahrávání

Pokud používáte Workers Script Upload API nebo Version Upload API přímo, multipart/form-data uploads vyžadují zadání metadata část. Tato metadata definují konfiguraci Workeru ve formátu JSON, obdobně jako soubor wrangler.toml.

{
	"main_module": "main.js",
	"bindings": [
		{
			"type": "plain_text",
			"name": "MESSAGE",
			"text": "Hello, world!"
		}
	],
	"compatibility_date": "2021-09-14"
}

Následující atributy lze konfigurovat na nejvyšší úrovni.

• main_module string povinné

  • Název části obsahující vstupní bod modulu Workeru, který se má spustit. Například main.js.

• assets object volitelné

  • Prostředek konfigurace Workeru.
  • config object volitelné
    • html_handling určuje přesměrování a přepisy požadavků na obsah HTML.
    • not_found_handling určuje odpověď v případě, že požadavek neodpovídá žádnému statickému aktivu.
  • jwt pole poskytuje token, který opravňuje připojení assetů k Workeru.

• keep_assets boolean volitelné

  • Určuje, zda se mají zachovat assets z dříve nahrané verze Workeru; používá se místo zadání completion tokenu.

• bindings array[object] volitelné

  • Bindings k vystavení ve Workeru.

• placement object volitelné

  • Smart placement objekt pro Worker.
  • mode pole podporuje jen smart pro automatické umístění.

• compatibility_date string volitelné

  • Datum kompatibility označující cílenou podporu v runtime Workers. Zpětně nekompatibilní opravy runtime po tomto datu tento Worker neovlivní. Důrazně doporučujeme nastavit compatibility_date, jinak se při nahrání přes API standardně použije nejstarší datum kompatibility před tím, než začaly platit jakékoli příznaky (2021-11-02).

• compatibility_flags array[string] volitelné

  • Příznaky kompatibility které zapínají nebo vypínají určité funkce v runtime Workers. Používají se k zapnutí nadcházejících funkcí nebo k zapnutí či vypnutí konkrétních změn, které nejsou součástí compatibility_date.

Pro ihned nasazené nahrané soubory, následující další atributy lze konfigurovat na nejvyšší úrovni.

• migrations array[object] volitelné

  • Migrace Durable Objects k použití.

• logpush boolean volitelné

  • Zda Logpush je pro Worker zapnuto.

• tail_consumers array[object] volitelné

  • Tail Workers která bude odebírat protokoly z připojeného Workeru.

• tags array[string] volitelné

  • Seznam řetězců, které se použijí jako štítky tohoto Workeru.

• annotations object volitelné

  • Objekt anotací pro verzi Workeru vytvořenou tímto nahráním. K dispozici je také na Version Upload API.
  • workers/message určuje vlastní zprávu pro tuto verzi.
  • workers/tag určuje vlastní identifikátor verze.

Pro nahrávání verzí, následující další atributy lze konfigurovat na nejvyšší úrovni.

• annotations object volitelné
  • Objekt anotací specifický pro danou verzi Workeru.
  • workers/message určuje vlastní zprávu pro tuto verzi.
  • workers/tag určuje vlastní identifikátor verze.
  • workers/alias určuje vlastní alias pro tuto verzi.

Workers mohou komunikovat s prostředky na Cloudflare Developer Platform pomocí vazby. Podívejte se na níže uvedený příklad JSON, který ukazuje, jak přidat bindings v metadata část.

{
	"bindings": [
		{
			"type": "ai",
			"name": "<VARIABLE_NAME>"
		},
		{
			"type": "analytics_engine",
			"name": "<VARIABLE_NAME>",
			"dataset": "<DATASET>"
		},
		{
			"type": "assets",
			"name": "<VARIABLE_NAME>"
		},
		{
			"type": "browser_rendering",
			"name": "<VARIABLE_NAME>"
		},
		{
			"type": "d1",
			"name": "<VARIABLE_NAME>",
			"id": "<D1_ID>"
		},
		{
			"type": "durable_object_namespace",
			"name": "<VARIABLE_NAME>",
			"class_name": "<DO_CLASS_NAME>"
		},
		{
			"type": "hyperdrive",
			"name": "<VARIABLE_NAME>",
			"id": "<HYPERDRIVE_ID>"
		},
		{
			"type": "kv_namespace",
			"name": "<VARIABLE_NAME>",
			"namespace_id": "<KV_ID>"
		},
		{
			"type": "mtls_certificate",
			"name": "<VARIABLE_NAME>",
			"certificate_id": "<MTLS_CERTIFICATE_ID>"
		},
		{
			"type": "plain_text",
			"name": "<VARIABLE_NAME>",
			"text": "<VARIABLE_VALUE>"
		},
		{
			"type": "queue",
			"name": "<VARIABLE_NAME>",
			"queue_name": "<QUEUE_NAME>"
		},
		{
			"type": "r2_bucket",
			"name": "<VARIABLE_NAME>",
			"bucket_name": "<R2_BUCKET_NAME>"
		},
		{
			"type": "secret_text",
			"name": "<VARIABLE_NAME>",
			"text": "<SECRET_VALUE>"
		},
		{
			"type": "service",
			"name": "<VARIABLE_NAME>",
			"service": "<SERVICE_NAME>",
			"environment": "production"
		},
		{
			"type": "vectorize",
			"name": "<VARIABLE_NAME>",
			"index_name": "<INDEX_NAME>"
		},
		{
			"type": "version_metadata",
			"name": "<VARIABLE_NAME>"
		}
	]
}