getDocsForError() — astro Function Reference

Architecture documentation for the getDocsForError() function in runtime.ts from the astro codebase.

Function typescript CoreAstro CoreMiddleware calls 1

Entity Profile

CoreAstro→ CoreMiddleware→ getDocsForError() — astro Function Reference

Dependency Diagram

graph TD
  995ccc85_b7cc_cd19_da14_452fc6ae9487["getDocsForError()"]
  d9525c93_ef37_466a_289a_043691fd3f8a["runtime.ts"]
  995ccc85_b7cc_cd19_da14_452fc6ae9487 -->|defined in| d9525c93_ef37_466a_289a_043691fd3f8a
  90e03cae_beaa_29ed_bbe0_118d429f61d7["getKebabErrorName()"]
  995ccc85_b7cc_cd19_da14_452fc6ae9487 -->|calls| 90e03cae_beaa_29ed_bbe0_118d429f61d7
  style 995ccc85_b7cc_cd19_da14_452fc6ae9487 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

packages/astro/src/core/errors/dev/runtime.ts lines 12–17

export function getDocsForError(err: ErrorWithMetadata): string | undefined {
	if (err.name !== 'UnknownError' && err.name in AstroErrorData) {
		return `https://docs.astro.build/en/reference/errors/${getKebabErrorName(err.name)}/`;
	}
	return undefined;
}