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
f1c4cb8b
Unverified
Commit
f1c4cb8b
authored
Aug 31, 2020
by
Luis Alvarez D
Committed by
GitHub
Aug 31, 2020
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Update preview mode docs to include API Routes (#16705)
Fixes
https://github.com/vercel/next.js/issues/16661
parent
ce994365
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
12 additions
and
0 deletions
+12
-0
preview-mode.md
docs/advanced-features/preview-mode.md
+12
-0
No files found.
docs/advanced-features/preview-mode.md
View file @
f1c4cb8b
...
@@ -203,6 +203,18 @@ You can pass an object to `setPreviewData` and have it be available in `getStati
...
@@ -203,6 +203,18 @@ You can pass an object to `setPreviewData` and have it be available in `getStati
The preview mode works on
`getServerSideProps`
as well. It will also be available on the
`context`
object containing
`preview`
and
`previewData`
.
The preview mode works on
`getServerSideProps`
as well. It will also be available on the
`context`
object containing
`preview`
and
`previewData`
.
### Works with API Routes
API Routes will have access to
`preview`
and
`previewData`
under the request object. For example:
```
js
export
default
function
myApiRoute
(
req
,
res
)
{
const
isPreview
=
req
.
preview
const
previewData
=
req
.
previewData
// ...
}
```
### Unique per `next build`
### Unique per `next build`
Both the bypass cookie value and the private key for encrypting the
`previewData`
change when
`next build`
is completed.
Both the bypass cookie value and the private key for encrypting the
`previewData`
change when
`next build`
is completed.
...
...
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