isEndpoint() — astro Function Reference

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

Function typescript CoreAstro RenderingEngine calls 4

Entity Profile

CoreAstro→ RenderingEngine→ isEndpoint() — astro Function Reference

Dependency Diagram

graph TD
  fa8579ea_f215_3452_2150_67519e6ea9cb["isEndpoint()"]
  a3824e79_205c_305b_a44f_edee1ef5faa4["util.ts"]
  fa8579ea_f215_3452_2150_67519e6ea9cb -->|defined in| a3824e79_205c_305b_a44f_edee1ef5faa4
  a8f8d845_6394_df88_feb8_2507e2df96d9["isInPagesDir()"]
  fa8579ea_f215_3452_2150_67519e6ea9cb -->|calls| a8f8d845_6394_df88_feb8_2507e2df96d9
  9331b40b_ff1f_4548_3a17_c33ae0f51a3f["isInjectedRoute()"]
  fa8579ea_f215_3452_2150_67519e6ea9cb -->|calls| 9331b40b_ff1f_4548_3a17_c33ae0f51a3f
  6dddd48e_7b79_3a2c_5963_3ff253a1002d["isPublicRoute()"]
  fa8579ea_f215_3452_2150_67519e6ea9cb -->|calls| 6dddd48e_7b79_3a2c_5963_3ff253a1002d
  ac4cc111_775a_ab7f_53db_e8cd0aeee9b6["endsWithPageExt()"]
  fa8579ea_f215_3452_2150_67519e6ea9cb -->|calls| ac4cc111_775a_ab7f_53db_e8cd0aeee9b6
  style fa8579ea_f215_3452_2150_67519e6ea9cb fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

packages/astro/src/core/util.ts lines 178–182

export function isEndpoint(file: URL, settings: AstroSettings): boolean {
	if (!isInPagesDir(file, settings.config) && !isInjectedRoute(file, settings)) return false;
	if (!isPublicRoute(file, settings.config)) return false;
	return !endsWithPageExt(file, settings) && !file.toString().includes('?astro');
}