sync() — astro Function Reference

Architecture documentation for the sync() function in index.ts from the astro codebase.

Function typescript CoreAstro RenderingEngine

Entity Profile

CoreAstro→ RenderingEngine→ sync() — astro Function Reference

Dependency Diagram

graph TD
  8938c7a5_8671_8813_5c8b_62554f17851d["sync()"]
  e03d202e_cca0_0a97_d015_be57061791db["index.ts"]
  8938c7a5_8671_8813_5c8b_62554f17851d -->|defined in| e03d202e_cca0_0a97_d015_be57061791db
  style 8938c7a5_8671_8813_5c8b_62554f17851d fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

packages/astro/src/cli/sync/index.ts lines 9–26

export async function sync({ flags }: SyncOptions) {
	if (flags?.help || flags?.h) {
		printHelp({
			commandName: 'astro sync',
			usage: '[...flags]',
			tables: {
				Flags: [
					['--force', 'Clear the content layer cache, forcing a full rebuild.'],
					['--help (-h)', 'See all available flags.'],
				],
			},
			description: `Generates TypeScript types for all Astro modules.`,
		});
		return 0;
	}

	await _sync(flagsToAstroInlineConfig(flags), { telemetry: true });
}