ContextQMD
Back to Withastro

Invalid route parameter returned by getStaticPaths().

src/content/docs/en/reference/errors/get-static-paths-invalid-route-param.mdx

latest1.1 KB
Original Source

import DontEditWarning from '~/components/DontEditWarning.astro'

<DontEditWarning />

GetStaticPathsInvalidRouteParam: Invalid getStaticPaths() route parameter for KEY. Expected a string or undefined, received VALUE_TYPE (VALUE)

What went wrong?

Since params are encoded into the URL, only certain types are supported as values.

astro
---
export async function getStaticPaths() {
	return [
		{ params: { id: '1' } } // Works
		{ params: { id: 2 } } // Does not work
		{ params: { id: false } } // Does not work
		{ params: { id: [1, 2] } } // Does not work
	];
}
---

In routes using rest parameters, undefined can be used to represent a path with no parameters passed in the URL:

astro
---
export async function getStaticPaths() {
	return [
		{ params: { id: '1' } } // /route/1
		{ params: { id: '2' } } // /route/2
		{ params: { id: undefined } } // /route/
	];
}
---

See Also: