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
02f2183d
Unverified
Commit
02f2183d
authored
Feb 13, 2026
by
Joseph
Committed by
GitHub
Feb 13, 2026
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
docs: adapterPath amends (#89930)
- use experimental versioning - fix spacing for graphs - spacing in [!NOTE]
parent
ea8651a7
Show whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
20 additions
and
13 deletions
+20
-13
adapterPath.mdx
...api-reference/05-config/01-next-config-js/adapterPath.mdx
+20
-13
No files found.
docs/01-app/03-api-reference/05-config/01-next-config-js/adapterPath.mdx
View file @
02f2183d
---
---
title
:
experimental
.
adapterPath
title
:
adapterPath
description
:
Configure
a
custom
adapter
for
Next
.
js
to
hook
into
the
build
process
with
modifyConfig
and
onBuildComplete
callbacks
.
description
:
Configure
a
custom
adapter
for
Next
.
js
to
hook
into
the
build
process
with
modifyConfig
and
onBuildComplete
callbacks
.
version
:
experimental
---
---
Next
.
js
provides
an
experimental
API
that
allows
you
to
create
custom
adapters
to
hook
into
the
build
process
.
This
is
useful
for
deployment
platforms
or
custom
build
integrations
that
need
to
modify
Next
.
js
configuration
or
process
build
outputs
.
Next
.
js
provides
an
experimental
API
that
allows
you
to
create
custom
adapters
to
hook
into
the
build
process
.
This
is
useful
for
deployment
platforms
or
custom
build
integrations
that
need
to
modify
Next
.
js
configuration
or
process
build
outputs
.
>
[
!
WARNING
]
>
`experimental.adapterPath`
is
experimental
and
may
change
.
For
a
full
reference
implementation
,
see
[
`nextjs/adapter-vercel`
](
https
://
github
.
com
/
nextjs
/
adapter
-
vercel
)
.
For
a
full
reference
implementation
,
see
[
`nextjs/adapter-vercel`
](
https
://
github
.
com
/
nextjs
/
adapter
-
vercel
)
.
## Configuration
## Configuration
...
@@ -250,14 +248,20 @@ Client
...
@@ -250,14 +248,20 @@ Client
| GET /ppr-route
| GET /ppr-route
v
v
Adapter Router
Adapter Router
|-- read cached shell + postponedState --> Platform Cache
|
|<------------- cache hit --------------|
|-- read cached shell + postponedState ---> Platform Cache
|<------------- cache hit -----------------|
|
|-- create responseStream = concat(shellStream, resumedStream)
|-- create responseStream = concat(shellStream, resumedStream)
|-- start piping shellStream -----------> Client (first bytes)
|
|-- start piping shellStream ------------> Client (first bytes)
|
|-- invoke handler(req, res, { requestMeta: { postponed } })
|-- invoke handler(req, res, { requestMeta: { postponed } })
| ------------------------------------> Entrypoint (handler)
| -------------------------------------> Entrypoint (handler)
| <------------------------------------ resumed chunks/cache entry
| <------------------------------------- resumed chunks/cache entry
|
|-- append resumed chunks to resumedStream
|-- append resumed chunks to resumedStream
|
'
--
client
receives
one
HTTP
response
:
'
--
client
receives
one
HTTP
response
:
[
shell
bytes
........
][
resumed
bytes
........
]
[
shell
bytes
........
][
resumed
bytes
........
]
```
```
...
@@ -267,8 +271,10 @@ Adapter Router
...
@@ -267,8 +271,10 @@ Adapter Router
`
requestMeta
.
onCacheEntryV2
` is called when a response cache entry is looked up or generated. Use it to persist updated shell/postponed data.
`
requestMeta
.
onCacheEntryV2
` is called when a response cache entry is looked up or generated. Use it to persist updated shell/postponed data.
> [!NOTE]
> [!NOTE]
> `
requestMeta
.
onCacheEntry
` still works, but is deprecated. Prefer `
requestMeta
.
onCacheEntryV2
`.
>
> If your adapter uses an internal `
onCacheCallback
` abstraction, wire it to `
requestMeta
.
onCacheEntryV2
`.
> - `
requestMeta
.
onCacheEntry
` still works, but is deprecated.
> - Prefer `
requestMeta
.
onCacheEntryV2
`.
> - If your adapter uses an internal `
onCacheCallback
` abstraction, wire it to `
requestMeta
.
onCacheEntryV2
`.
```
ts
filename
=
"my-adapter.ts"
```
ts
filename
=
"my-adapter.ts"
await
handler
(
req
,
res
,
{
await
handler
(
req
,
res
,
{
...
@@ -304,7 +310,8 @@ Entrypoint (handler)
...
@@ -304,7 +310,8 @@ Entrypoint (handler)
|
onCacheEntryV2
(
cacheEntry
,
{
url
})
|
onCacheEntryV2
(
cacheEntry
,
{
url
})
v
v
requestMeta
.
onCacheEntryV2
callback
requestMeta
.
onCacheEntryV2
callback
|--
if
APP_PAGE
-->
persist
html
+
postponedState
+
headers
-->
Platform
Cache
|
|--
if
APP_PAGE
--->
persist
html
+
postponedState
+
headers
--->
Platform
Cache
|
|
'-- return false: continue normal Next.js response flow
'-- return false: continue normal Next.js response flow
return true: adapter already handled response (short-circuit)
return true: adapter already handled response (short-circuit)
...
...
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