Function onPrerenderRoute

packages/next/src/utils.ts:2520–3637

(prerenderRouteArgs: OnPrerenderRouteArgs)

export const onPrerenderRoute =
  (prerenderRouteArgs: OnPrerenderRouteArgs) =>
  async (
    routeKey: string,
    {
      isBlocking,
      isFallback,
      isOmitted,
      locale,
    }: {
      /**
       * A route is a blocking fallback route if its value in the prerender
       * manifest is `null`. This means that unless the page has been
       * prerendered (no dynamic params), we can't serve a fallback page for the
       * route as it depends on the dynamic params values.
       */
      isBlocking?: boolean;

      /**
       * A route is a fallback route if its value in the prerender manifest is
       * a string (meaning there is a fallback value/page). This occurs when
       * the page is rendered with dynamic params but it's rendered in such a
       * way that it's value can be reused for all variants of the dynamic
       * params.
       */
      isFallback?: boolean;

      /**
       * A route is omitted if its value in the prerender manifest is `false`.
       * This can only be set when the `dynamicParams` is set to `false` for
       * the dynamic route.
       */
      isOmitted?: boolean;
      locale?: string;
    }
  ) => {
    const {
      appDir,
      pagesDir,
      static404Page,
      localePrefixed404,
      entryDirectory,
      prerenderManifest,
      isSharedLambdas,
      isServerMode,
      canUsePreviewMode,
      lambdas,
      experimentalStreamingLambdaPaths,
      prerenders,
      pageLambdaMap,
      routesManifest,
      isCorrectNotFoundRoutes,
      isEmptyAllowQueryForPrendered,
      isAppPPREnabled,
      isAppClientSegmentCacheEnabled,
      isAppClientParamParsingEnabled,
      appPathnameFilesMap,
      nextVersion,
    } = prerenderRouteArgs;