validateOptions() — astro Function Reference

Architecture documentation for the validateOptions() function in validate-options.ts from the astro codebase.

Function typescript CoreAstro RoutingSystem

Entity Profile

CoreAstro→ RoutingSystem→ validateOptions() — astro Function Reference

Dependency Diagram

graph TD
  4fced0ef_0770_f0f3_4aab_2bfe9ae0547f["validateOptions()"]
  3325e896_efbb_d220_9c03_12ceb805ec1d["validate-options.ts"]
  4fced0ef_0770_f0f3_4aab_2bfe9ae0547f -->|defined in| 3325e896_efbb_d220_9c03_12ceb805ec1d
  style 4fced0ef_0770_f0f3_4aab_2bfe9ae0547f fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

packages/integrations/sitemap/src/validate-options.ts lines 6–22

export const validateOptions = (site: string | undefined, opts: SitemapOptions) => {
	const result = SitemapOptionsSchema.parse(opts);

	z.object({
		site: z.string().optional(), // Astro takes care of `site`: how to validate, transform and refine
		canonicalURL: z.string().optional(), // `canonicalURL` is already validated in prev step
	})
		.refine((options) => options.site || options.canonicalURL, {
			message: 'Required `site` astro.config option or `canonicalURL` integration option',
		})
		.parse({
			site,
			canonicalURL: result.canonicalURL,
		});

	return result;
};