Sanity Library Reference Docs
Preparing search index...
@sanity/client
index
<internal>
MiddlewareHooks
Interface MiddlewareHooks
interface
MiddlewareHooks
{
processOptions
:
(
options
:
RequestOptions
)
=>
RequestOptions
;
validateOptions
:
(
options
:
RequestOptions
)
=>
void
|
undefined
;
interceptRequest
:
(
prevValue
:
MiddlewareResponse
|
undefined
,
event
:
{
adapter
:
RequestAdapter
;
context
:
HttpContext
}
,
)
=>
void
|
MiddlewareResponse
|
undefined
;
finalizeOptions
:
(
options
:
RequestOptions
|
FinalizeNodeOptionsPayload
,
)
=>
RequestOptions
|
FinalizeNodeOptionsPayload
;
onRequest
:
(
evt
:
HookOnRequestEvent
)
=>
void
;
onResponse
:
(
response
:
MiddlewareResponse
,
context
:
HttpContext
,
)
=>
MiddlewareResponse
;
onError
:
(
err
:
Error
|
null
,
context
:
HttpContext
)
=>
any
;
onReturn
:
(
channels
:
MiddlewareChannels
,
context
:
HttpContext
)
=>
any
;
onHeaders
:
(
response
:
IncomingMessage
,
evt
:
{
headers
:
IncomingHttpHeaders
;
adapter
:
RequestAdapter
;
context
:
HttpContext
;
}
,
)
=>
ProgressStream
;
}
Index
Properties
process
Options
validate
Options
intercept
Request
finalize
Options
on
Request
on
Response
on
Error
on
Return
on
Headers
Properties
process
Options
processOptions
:
(
options
:
RequestOptions
)
=>
RequestOptions
validate
Options
validateOptions
:
(
options
:
RequestOptions
)
=>
void
|
undefined
intercept
Request
interceptRequest
:
(
prevValue
:
MiddlewareResponse
|
undefined
,
event
:
{
adapter
:
RequestAdapter
;
context
:
HttpContext
}
,
)
=>
void
|
MiddlewareResponse
|
undefined
finalize
Options
finalizeOptions
:
(
options
:
RequestOptions
|
FinalizeNodeOptionsPayload
,
)
=>
RequestOptions
|
FinalizeNodeOptionsPayload
on
Request
onRequest
:
(
evt
:
HookOnRequestEvent
)
=>
void
on
Response
onResponse
:
(
response
:
MiddlewareResponse
,
context
:
HttpContext
,
)
=>
MiddlewareResponse
on
Error
onError
:
(
err
:
Error
|
null
,
context
:
HttpContext
)
=>
any
on
Return
onReturn
:
(
channels
:
MiddlewareChannels
,
context
:
HttpContext
)
=>
any
on
Headers
onHeaders
:
(
response
:
IncomingMessage
,
evt
:
{
headers
:
IncomingHttpHeaders
;
adapter
:
RequestAdapter
;
context
:
HttpContext
;
}
,
)
=>
ProgressStream
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Properties
process
Options
validate
Options
intercept
Request
finalize
Options
on
Request
on
Response
on
Error
on
Return
on
Headers
Sanity Library Reference Docs
Loading...