Skip to content
Projects
Groups
Snippets
Help
Loading...
Sign in
Toggle navigation
N
next.js
Project
Project
Details
Activity
Cycle Analytics
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Charts
Issues
0
Issues
0
List
Board
Labels
Milestones
Merge Requests
0
Merge Requests
0
CI / CD
CI / CD
Pipelines
Jobs
Schedules
Charts
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Charts
Create a new issue
Jobs
Commits
Issue Boards
Open sidebar
Alex
next.js
Commits
2972c068
Unverified
Commit
2972c068
authored
Oct 27, 2020
by
Joe Haddad
Committed by
GitHub
Oct 27, 2020
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Improve type for GSP return type (#18285)
parent
4782bda3
Hide whitespace changes
Inline
Side-by-side
Showing
2 changed files
with
21 additions
and
23 deletions
+21
-23
render.tsx
packages/next/next-server/server/render.tsx
+14
-8
index.d.ts
packages/next/types/index.d.ts
+7
-15
No files found.
packages/next/next-server/server/render.tsx
View file @
2972c068
...
@@ -636,7 +636,7 @@ export async function renderToHTML(
...
@@ -636,7 +636,7 @@ export async function renderToHTML(
throw
new
Error
(
invalidKeysMsg
(
'getStaticProps'
,
invalidKeys
))
throw
new
Error
(
invalidKeysMsg
(
'getStaticProps'
,
invalidKeys
))
}
}
if
(
data
.
unstable_notFound
)
{
if
(
'unstable_notFound'
in
data
&&
data
.
unstable_notFound
)
{
if
(
pathname
===
'/404'
)
{
if
(
pathname
===
'/404'
)
{
throw
new
Error
(
throw
new
Error
(
`The /404 page can not return unstable_notFound in "getStaticProps", please remove it to continue!`
`The /404 page can not return unstable_notFound in "getStaticProps", please remove it to continue!`
...
@@ -649,6 +649,7 @@ export async function renderToHTML(
...
@@ -649,6 +649,7 @@ export async function renderToHTML(
}
}
if
(
if
(
'unstable_redirect'
in
data
&&
data
.
unstable_redirect
&&
data
.
unstable_redirect
&&
typeof
data
.
unstable_redirect
===
'object'
typeof
data
.
unstable_redirect
===
'object'
)
{
)
{
...
@@ -662,7 +663,7 @@ export async function renderToHTML(
...
@@ -662,7 +663,7 @@ export async function renderToHTML(
}
}
if
(
isDataReq
)
{
if
(
isDataReq
)
{
data
.
props
=
{
;(
data
as
any
)
.
props
=
{
__N_REDIRECT
:
data
.
unstable_redirect
.
destination
,
__N_REDIRECT
:
data
.
unstable_redirect
.
destination
,
}
}
}
else
{
}
else
{
...
@@ -673,7 +674,7 @@ export async function renderToHTML(
...
@@ -673,7 +674,7 @@ export async function renderToHTML(
if
(
if
(
(
dev
||
isBuildTimeSSG
)
&&
(
dev
||
isBuildTimeSSG
)
&&
!
isSerializableProps
(
pathname
,
'getStaticProps'
,
data
.
props
)
!
isSerializableProps
(
pathname
,
'getStaticProps'
,
(
data
as
any
)
.
props
)
)
{
)
{
// this fn should throw an error instead of ever returning `false`
// this fn should throw an error instead of ever returning `false`
throw
new
Error
(
throw
new
Error
(
...
@@ -681,7 +682,7 @@ export async function renderToHTML(
...
@@ -681,7 +682,7 @@ export async function renderToHTML(
)
)
}
}
if
(
typeof
data
.
revalidate
===
'number'
)
{
if
(
'revalidate'
in
data
&&
typeof
data
.
revalidate
===
'number'
)
{
if
(
!
Number
.
isInteger
(
data
.
revalidate
))
{
if
(
!
Number
.
isInteger
(
data
.
revalidate
))
{
throw
new
Error
(
throw
new
Error
(
`A page's revalidate option must be seconds expressed as a natural number. Mixed numbers, such as '
${
data
.
revalidate
}
', cannot be used.`
+
`A page's revalidate option must be seconds expressed as a natural number. Mixed numbers, such as '
${
data
.
revalidate
}
', cannot be used.`
+
...
@@ -702,20 +703,25 @@ export async function renderToHTML(
...
@@ -702,20 +703,25 @@ export async function renderToHTML(
`\nTo only run getStaticProps at build-time and not revalidate at runtime, you can set \`revalidate\` to \`false\`!`
`\nTo only run getStaticProps at build-time and not revalidate at runtime, you can set \`revalidate\` to \`false\`!`
)
)
}
}
}
else
if
(
data
.
revalidate
===
true
)
{
}
else
if
(
'revalidate'
in
data
&&
data
.
revalidate
===
true
)
{
// When enabled, revalidate after 1 second. This value is optimal for
// When enabled, revalidate after 1 second. This value is optimal for
// the most up-to-date page possible, but without a 1-to-1
// the most up-to-date page possible, but without a 1-to-1
// request-refresh ratio.
// request-refresh ratio.
data
.
revalidate
=
1
data
.
revalidate
=
1
}
else
{
}
else
{
// By default, we never revalidate.
// By default, we never revalidate.
data
.
revalidate
=
false
;(
data
as
any
)
.
revalidate
=
false
}
}
props
.
pageProps
=
Object
.
assign
({},
props
.
pageProps
,
data
.
props
)
props
.
pageProps
=
Object
.
assign
(
{},
props
.
pageProps
,
'props'
in
data
?
data
.
props
:
undefined
)
// pass up revalidate and props for export
// pass up revalidate and props for export
// TODO: change this to a different passing mechanism
// TODO: change this to a different passing mechanism
;(
renderOpts
as
any
).
revalidate
=
data
.
revalidate
;(
renderOpts
as
any
).
revalidate
=
'revalidate'
in
data
?
data
.
revalidate
:
undefined
;(
renderOpts
as
any
).
pageData
=
props
;(
renderOpts
as
any
).
pageData
=
props
}
}
...
...
packages/next/types/index.d.ts
View file @
2972c068
...
@@ -85,12 +85,10 @@ export type GetStaticPropsContext<Q extends ParsedUrlQuery = ParsedUrlQuery> = {
...
@@ -85,12 +85,10 @@ export type GetStaticPropsContext<Q extends ParsedUrlQuery = ParsedUrlQuery> = {
locales
?:
string
[]
locales
?:
string
[]
}
}
export
type
GetStaticPropsResult
<
P
>
=
{
export
type
GetStaticPropsResult
<
P
>
=
props
?:
P
|
{
props
:
P
;
revalidate
?:
number
|
boolean
}
revalidate
?:
number
|
boolean
|
{
unstable_redirect
:
Redirect
;
revalidate
?:
number
|
boolean
}
unstable_redirect
?:
Redirect
|
{
unstable_notFound
:
true
}
unstable_notFound
?:
true
}
export
type
GetStaticProps
<
export
type
GetStaticProps
<
P
extends
{
[
key
:
string
]:
any
}
=
{
[
key
:
string
]:
any
},
P
extends
{
[
key
:
string
]:
any
}
=
{
[
key
:
string
]:
any
},
...
@@ -133,15 +131,9 @@ export type GetServerSidePropsContext<
...
@@ -133,15 +131,9 @@ export type GetServerSidePropsContext<
}
}
export
type
GetServerSidePropsResult
<
P
>
=
export
type
GetServerSidePropsResult
<
P
>
=
|
{
|
{
props
:
P
}
props
:
P
|
{
unstable_redirect
:
Redirect
}
}
|
{
unstable_notFound
:
true
}
|
{
unstable_redirect
:
Redirect
}
|
{
unstable_notFound
:
true
}
export
type
GetServerSideProps
<
export
type
GetServerSideProps
<
P
extends
{
[
key
:
string
]:
any
}
=
{
[
key
:
string
]:
any
},
P
extends
{
[
key
:
string
]:
any
}
=
{
[
key
:
string
]:
any
},
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment