imageMetadata() — astro Function Reference

Architecture documentation for the imageMetadata() function in metadata.ts from the astro codebase.

Function typescript CoreAstro RenderingEngine

Entity Profile

CoreAstro→ RenderingEngine→ imageMetadata() — astro Function Reference

Dependency Diagram

graph TD
  fe03d578_04f0_7fd4_f32d_af3a508dbab2["imageMetadata()"]
  f7e2fa0f_185a_721c_2dec_cc06429c3ee5["metadata.ts"]
  fe03d578_04f0_7fd4_f32d_af3a508dbab2 -->|defined in| f7e2fa0f_185a_721c_2dec_cc06429c3ee5
  style fe03d578_04f0_7fd4_f32d_af3a508dbab2 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

packages/astro/src/assets/utils/metadata.ts lines 13–42

export async function imageMetadata(
	data: Uint8Array,
	src?: string,
): Promise<Omit<ImageMetadata, 'src' | 'fsPath'>> {
	let result;
	try {
		result = probe(data);
	} catch {
		throw new AstroError({
			...AstroErrorData.NoImageMetadata,
			message: AstroErrorData.NoImageMetadata.message(src),
		});
	}
	if (!result.height || !result.width || !result.type) {
		throw new AstroError({
			...AstroErrorData.NoImageMetadata,
			message: AstroErrorData.NoImageMetadata.message(src),
		});
	}

	const { width, height, type, orientation } = result;
	const isPortrait = (orientation || 0) >= 5;

	return {
		width: isPortrait ? height : width,
		height: isPortrait ? width : height,
		format: type as ImageInputFormat,
		orientation,
	};
}