Unverified Commit c988b99c authored by sic!kh's avatar sic!kh Committed by GitHub

(Docs) getStaticProps & getServerSideProps TS section (#40607) (#40639)

Added examples to `getStaticProps` & `getServerSideProps` explicit and implicit typings for TypeScript.

Related issues: fixes https://github.com/vercel/next.js/issues/40607Co-authored-by: 's avatarBalázs Orbán <18369201+balazsorban44@users.noreply.github.com>
parent 3ede313e
...@@ -104,18 +104,53 @@ export async function getServerSideProps(context) { ...@@ -104,18 +104,53 @@ export async function getServerSideProps(context) {
### getServerSideProps with TypeScript ### getServerSideProps with TypeScript
For TypeScript, you can use the `GetServerSideProps` type from `next`: The type of `getServerSideProps` can be specified using `GetServerSideProps` from `next`:
```ts ```ts
import { GetServerSideProps } from 'next' import { GetServerSideProps } from 'next'
export const getServerSideProps: GetServerSideProps = async (context) => { type Data = { ... }
// ...
export const getServerSideProps: GetServerSideProps<{ data: Data }> = async (context) => {
const res = await fetch('https://.../data')
const data: Data = await res.json()
return {
props: {
data,
},
}
} }
``` ```
If you want to get inferred typings for your props, you can use `InferGetServerSidePropsType<typeof getServerSideProps>`: If you want to get inferred typings for your props, you can use `InferGetServerSidePropsType<typeof getServerSideProps>`:
```tsx
import { InferGetServerSidePropsType } from 'next'
import { GetServerSideProps } from 'next'
type Data = { ... }
export const getServerSideProps: GetServerSideProps<{ data: Data }> = async () => {
const res = await fetch('https://.../data')
const data: Data = await res.json()
return {
props: {
data,
},
}
}
function Page({ data }: InferGetServerSidePropsType<typeof getServerSideProps>) {
// will resolve data to type Data
}
export default Page
```
Implicit typing for `getServerSideProps` will also work properly:
```tsx ```tsx
import { InferGetServerSidePropsType } from 'next' import { InferGetServerSidePropsType } from 'next'
...@@ -133,7 +168,7 @@ export const getServerSideProps = async () => { ...@@ -133,7 +168,7 @@ export const getServerSideProps = async () => {
} }
function Page({ data }: InferGetServerSidePropsType<typeof getServerSideProps>) { function Page({ data }: InferGetServerSidePropsType<typeof getServerSideProps>) {
// will resolve posts to type Data // will resolve data to type Data
} }
export default Page export default Page
......
...@@ -202,18 +202,61 @@ export default Blog ...@@ -202,18 +202,61 @@ export default Blog
## getStaticProps with TypeScript ## getStaticProps with TypeScript
You can use the `GetStaticProps` type from `next` to type the function: The type of `getStaticProps` can be specified using `GetStaticProps` from `next`:
```ts ```ts
import { GetStaticProps } from 'next' import { GetStaticProps } from 'next'
export const getStaticProps: GetStaticProps = async (context) => { type Post = {
// ... author: string
content: string
}
export const getStaticProps: GetStaticProps<{ posts: Post[] }> = async (
context
) => {
const res = await fetch('https://.../posts')
const posts: Post[] = await res.json()
return {
props: {
posts,
},
}
} }
``` ```
If you want to get inferred typings for your props, you can use `InferGetStaticPropsType<typeof getStaticProps>`: If you want to get inferred typings for your props, you can use `InferGetStaticPropsType<typeof getStaticProps>`:
```tsx
import { InferGetStaticPropsType } from 'next'
import { GetStaticProps } from 'next'
type Post = {
author: string
content: string
}
export const getStaticProps: GetStaticProps<{ posts: Post[] }> = async () => {
const res = await fetch('https://.../posts')
const posts: Post[] = await res.json()
return {
props: {
posts,
},
}
}
function Blog({ posts }: InferGetStaticPropsType<typeof getStaticProps>) {
// will resolve posts to type Post[]
}
export default Blog
```
Implicit typing for `getStaticProps` will also work properly:
```tsx ```tsx
import { InferGetStaticPropsType } from 'next' import { InferGetStaticPropsType } from 'next'
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment