cloudflareConfigCustomizer() — astro Function Reference

Architecture documentation for the cloudflareConfigCustomizer() function in wrangler.ts from the astro codebase.

Function typescript CoreAstro RoutingSystem

Entity Profile

CoreAstro→ RoutingSystem→ cloudflareConfigCustomizer() — astro Function Reference

Dependency Diagram

graph TD
  bf7c31ac_c466_32d1_cad6_38d2a83df68a["cloudflareConfigCustomizer()"]
  ff9e7216_f07c_ea5c_54f9_058d9086059e["wrangler.ts"]
  bf7c31ac_c466_32d1_cad6_38d2a83df68a -->|defined in| ff9e7216_f07c_ea5c_54f9_058d9086059e
  style bf7c31ac_c466_32d1_cad6_38d2a83df68a fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

packages/integrations/cloudflare/src/wrangler.ts lines 16–54

export function cloudflareConfigCustomizer(
	options?: CloudflareConfigOptions,
): PluginConfig['config'] {
	const sessionKVBindingName = options?.sessionKVBindingName ?? DEFAULT_SESSION_KV_BINDING_NAME;
	const imagesBindingName =
		options?.imagesBindingName === false
			? undefined
			: (options?.imagesBindingName ?? DEFAULT_IMAGES_BINDING_NAME);

	return (config) => {
		const hasSessionBinding = config.kv_namespaces?.some(
			(kv) => kv.binding === sessionKVBindingName,
		);
		const hasImagesBinding = config.images?.binding !== undefined;
		const hasAssetsBinding = config.assets?.binding !== undefined;

		return {
			main: config.main ?? '@astrojs/cloudflare/entrypoints/server',
			kv_namespaces: hasSessionBinding
				? undefined
				: [
						{
							binding: sessionKVBindingName,
						},
					],
			images:
				hasImagesBinding || !imagesBindingName
					? undefined
					: {
							binding: imagesBindingName,
						},
			assets: hasAssetsBinding
				? undefined
				: {
						binding: DEFAULT_ASSETS_BINDING_NAME,
					},
		};
	};
}