fix getStaticPaths typing

[hori-ryota]

Changes

fix typing around getStaticPaths

• Be short and concise. Bullet points can help!

• resolve Page prop is type never with InferGetStaticPropsType #7159

Testing

import type { InferGetStaticPropsType, PaginateFunction } from "astro";

type Post = {
  title: string;
  body: string;
};

export function getStaticPaths({
  paginate,
}: {
  paginate: PaginateFunction<Post>;
}) {
  return paginate(
    [
      {
        title: "title1",
        body: "body1",
      },
    ],
    { pageSize: 10 },
  );
}
type Props = InferGetStaticPropsType<typeof getStaticPaths>;

before

type Props = never

after

type Props = Props & {
    page: Page<Post>;
}

Docs

/cc @withastro/maintainers-docs for feedback!

[changeset-bot]

🦋 Changeset detected

Latest commit: 5326190

The changes in this PR will be included in the next version bump.

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

[Princesseuh]

I overall like this, though a solution directly in our language tooling would still be preferable. It'll need some docs on our TypeScript page to explain how to type Paginate's type manually. It's also a bit unfortunate that it doesn't work with the satisfies GetStaticPaths pattern we show on our docs.

Additionally, a small bug I noticed:

export const getStaticPaths = (async ({ paginate }) => {
  const posts = await getCollection("blog");
  const paginated = posts.map((post) => {
    return {
      params: { slug: post.slug },
      props: { draft: false, title: post.data.title },
    };
  });

  return paginate(paginated, { pageSize: 10 });
}) satisfies GetStaticPaths;

In this code, paginate has the type PaginateFunction<GetStaticPathsItem, GetStaticPathsItem>, which cause params to be necessary in the second argument of paginate:

[Princesseuh]

Superseded by #8229, thank you very much for your contribution!