EnvFieldMetadata() — astro Function Reference

Architecture documentation for the EnvFieldMetadata() function in schema.ts from the astro codebase.

Function typescript CoreAstro RenderingEngine

Entity Profile

CoreAstro→ RenderingEngine→ EnvFieldMetadata() — astro Function Reference

Dependency Diagram

graph TD
  a517c840_9f3b_40d4_2000_16184eedc8de["EnvFieldMetadata()"]
  d9c64fcc_8e8a_5778_7acf_2d11fa82f9c4["schema.ts"]
  a517c840_9f3b_40d4_2000_16184eedc8de -->|defined in| d9c64fcc_8e8a_5778_7acf_2d11fa82f9c4
  style a517c840_9f3b_40d4_2000_16184eedc8de fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

packages/astro/src/env/schema.ts lines 83–102

const EnvFieldMetadata = z.custom<z.input<typeof _EnvFieldMetadata>>().superRefine((data, ctx) => {
	const result = _EnvFieldMetadata.safeParse(data);
	if (result.success) {
		return;
	}
	for (const issue of result.error.issues) {
		if (issue.code === z.ZodIssueCode.invalid_union) {
			ctx.addIssue({
				code: z.ZodIssueCode.custom,
				message: `**Invalid combination** of "access" and "context" options:\n  Secret client variables are not supported. Please review the configuration.\n  Learn more at https://docs.astro.build/en/guides/environment-variables/#variable-types`,
				path: ['context', 'access'],
			});
		} else {
			ctx.addIssue({
				...issue,
				code: 'custom',
			});
		}
	}
});