getOutputFilename() — astro Function Reference

Architecture documentation for the getOutputFilename() function in util.ts from the astro codebase.

Function typescript CoreAstro RenderingEngine

Entity Profile

CoreAstro→ RenderingEngine→ getOutputFilename() — astro Function Reference

Dependency Diagram

graph TD
  38b654d6_b2be_8c1c_dad2_097b0a09fcfd["getOutputFilename()"]
  a3824e79_205c_305b_a44f_edee1ef5faa4["util.ts"]
  38b654d6_b2be_8c1c_dad2_097b0a09fcfd -->|defined in| a3824e79_205c_305b_a44f_edee1ef5faa4
  style 38b654d6_b2be_8c1c_dad2_097b0a09fcfd fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

packages/astro/src/core/util.ts lines 51–69

export function getOutputFilename(
	buildFormat: NonNullable<AstroConfig['build']>['format'],
	name: string,
	routeData: RouteData,
) {
	if (routeData.type === 'endpoint') {
		return name;
	}
	if (name === '/' || name === '') {
		return path.posix.join(name, 'index.html');
	}
	if (buildFormat === 'file' || STATUS_CODE_PAGES.has(name)) {
		return `${removeTrailingForwardSlash(name || 'index')}.html`;
	}
	if (buildFormat === 'preserve' && !routeData.isIndex) {
		return `${removeTrailingForwardSlash(name || 'index')}.html`;
	}
	return path.posix.join(name, 'index.html');
}