Preparing search index...
The search index is not available
React Router API Reference
React Router API Reference
react-router
StaticHandler
Interface StaticHandler
A StaticHandler instance manages a singular SSR navigation/fetch event
interface
StaticHandler
{
dataRoutes
:
AgnosticDataRouteObject
[]
;
query
(
request
:
Request
,
opts
?:
{
dataStrategy
?:
DataStrategyFunction
<
unknown
>
;
filterMatchesToLoad
?:
(
(
match
:
AgnosticDataRouteMatch
)
=>
boolean
)
;
requestContext
?:
unknown
;
skipLoaderErrorBubbling
?:
boolean
;
skipRevalidation
?:
boolean
;
unstable_respond
?:
(
(
staticContext
:
StaticHandlerContext
)
=>
MaybePromise
<
Response
>
)
;
}
)
:
Promise
<
Response
|
StaticHandlerContext
>
;
queryRoute
(
request
:
Request
,
opts
?:
{
dataStrategy
?:
DataStrategyFunction
<
unknown
>
;
requestContext
?:
unknown
;
routeId
?:
string
;
unstable_respond
?:
(
(
res
:
Response
)
=>
MaybePromise
<
Response
>
)
;
}
)
:
Promise
<
any
>
;
}
Index
Properties
data
Routes
Methods
query
query
Route
Properties
data
Routes
data
Routes
:
AgnosticDataRouteObject
[]
Methods
query
query
(
request
,
opts
?
)
:
Promise
<
Response
|
StaticHandlerContext
>
Parameters
request
:
Request
Optional
opts
:
{
dataStrategy
?:
DataStrategyFunction
<
unknown
>
;
filterMatchesToLoad
?:
(
(
match
:
AgnosticDataRouteMatch
)
=>
boolean
)
;
requestContext
?:
unknown
;
skipLoaderErrorBubbling
?:
boolean
;
skipRevalidation
?:
boolean
;
unstable_respond
?:
(
(
staticContext
:
StaticHandlerContext
)
=>
MaybePromise
<
Response
>
)
;
}
Optional
data
Strategy
?:
DataStrategyFunction
<
unknown
>
Optional
filter
Matches
To
Load
?:
(
(
match
:
AgnosticDataRouteMatch
)
=>
boolean
)
(
match
)
:
boolean
Parameters
match
:
AgnosticDataRouteMatch
Returns
boolean
Optional
request
Context
?:
unknown
Optional
skip
Loader
Error
Bubbling
?:
boolean
Optional
skip
Revalidation
?:
boolean
Optional
unstable_
respond
?:
(
(
staticContext
:
StaticHandlerContext
)
=>
MaybePromise
<
Response
>
)
(
staticContext
)
:
MaybePromise
<
Response
>
Parameters
staticContext
:
StaticHandlerContext
Returns
MaybePromise
<
Response
>
Returns
Promise
<
Response
|
StaticHandlerContext
>
query
Route
query
Route
(
request
,
opts
?
)
:
Promise
<
any
>
Parameters
request
:
Request
Optional
opts
:
{
dataStrategy
?:
DataStrategyFunction
<
unknown
>
;
requestContext
?:
unknown
;
routeId
?:
string
;
unstable_respond
?:
(
(
res
:
Response
)
=>
MaybePromise
<
Response
>
)
;
}
Optional
data
Strategy
?:
DataStrategyFunction
<
unknown
>
Optional
request
Context
?:
unknown
Optional
route
Id
?:
string
Optional
unstable_
respond
?:
(
(
res
:
Response
)
=>
MaybePromise
<
Response
>
)
(
res
)
:
MaybePromise
<
Response
>
Parameters
res
:
Response
Returns
MaybePromise
<
Response
>
Returns
Promise
<
any
>
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Properties
data
Routes
Methods
query
query
Route
React Router API Reference
Loading...
A StaticHandler instance manages a singular SSR navigation/fetch event