IntegrationResolvedRoute Type — astro Architecture

Source Code

packages/astro/src/types/public/integrations.ts lines 346–388

export interface IntegrationResolvedRoute
	extends Pick<RouteData, 'params' | 'pathname' | 'segments' | 'type' | 'redirect' | 'origin'> {
	/**
	 * {@link RouteData.route}
	 */
	pattern: RouteData['route'];

	/**
	 * {@link RouteData.pattern}
	 */
	patternRegex: RouteData['pattern'];

	/**
	 * {@link RouteData.component}
	 */
	entrypoint: RouteData['component'];

	/**
	 * {@link RouteData.prerender}
	 */
	isPrerendered: RouteData['prerender'];

	/**
	 * {@link RouteData.redirectRoute}
	 */
	redirectRoute?: IntegrationResolvedRoute;

	/**
	 * @param {any} data The optional parameters of the route
	 *
	 * @description
	 * A function that accepts a list of params, interpolates them with the route pattern, and returns the path name of the route.
	 *
	 * ## Example
	 *
	 * For a route such as `/blog/[...id].astro`, the `generate` function would return something like this:
	 *
	 * ```js
	 * console.log(generate({ id: 'presentation' })) // will log `/blog/presentation`
	 * ```
	 */
	generate: (data?: any) => string;
}