React Router API Reference
Preparing search index...
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
;
generateMiddlewareResponse
?:
(
query
:
(
r
:
Request
,
args
?:
{
filterMatchesToLoad
?:
(
match
:
AgnosticDataRouteMatch
)
=>
boolean
;
}
,
)
=>
Promise
<
Response
|
StaticHandlerContext
>
,
)
=>
MaybePromise
<
Response
>
;
requestContext
?:
unknown
;
skipLoaderErrorBubbling
?:
boolean
;
skipRevalidation
?:
boolean
;
}
,
)
:
Promise
<
Response
|
StaticHandlerContext
>
;
queryRoute
(
request
:
Request
,
opts
?:
{
dataStrategy
?:
DataStrategyFunction
<
unknown
>
;
generateMiddlewareResponse
?:
(
queryRoute
:
(
r
:
Request
)
=>
Promise
<
Response
>
,
)
=>
MaybePromise
<
Response
>
;
requestContext
?:
unknown
;
routeId
?:
string
;
}
,
)
:
Promise
<
any
>
;
}
Index
Properties
data
Routes
Methods
query
query
Route
Properties
data
Routes
dataRoutes
:
AgnosticDataRouteObject
[]
Methods
query
query
(
request
:
Request
,
opts
?:
{
dataStrategy
?:
DataStrategyFunction
<
unknown
>
;
filterMatchesToLoad
?:
(
match
:
AgnosticDataRouteMatch
)
=>
boolean
;
generateMiddlewareResponse
?:
(
query
:
(
r
:
Request
,
args
?:
{
filterMatchesToLoad
?:
(
match
:
AgnosticDataRouteMatch
)
=>
boolean
;
}
,
)
=>
Promise
<
Response
|
StaticHandlerContext
>
,
)
=>
MaybePromise
<
Response
>
;
requestContext
?:
unknown
;
skipLoaderErrorBubbling
?:
boolean
;
skipRevalidation
?:
boolean
;
}
,
)
:
Promise
<
Response
|
StaticHandlerContext
>
Parameters
request
:
Request
Optional
opts
:
{
dataStrategy
?:
DataStrategyFunction
<
unknown
>
;
filterMatchesToLoad
?:
(
match
:
AgnosticDataRouteMatch
)
=>
boolean
;
generateMiddlewareResponse
?:
(
query
:
(
r
:
Request
,
args
?:
{
filterMatchesToLoad
?:
(
match
:
AgnosticDataRouteMatch
)
=>
boolean
;
}
,
)
=>
Promise
<
Response
|
StaticHandlerContext
>
,
)
=>
MaybePromise
<
Response
>
;
requestContext
?:
unknown
;
skipLoaderErrorBubbling
?:
boolean
;
skipRevalidation
?:
boolean
;
}
Returns
Promise
<
Response
|
StaticHandlerContext
>
query
Route
queryRoute
(
request
:
Request
,
opts
?:
{
dataStrategy
?:
DataStrategyFunction
<
unknown
>
;
generateMiddlewareResponse
?:
(
queryRoute
:
(
r
:
Request
)
=>
Promise
<
Response
>
,
)
=>
MaybePromise
<
Response
>
;
requestContext
?:
unknown
;
routeId
?:
string
;
}
,
)
:
Promise
<
any
>
Parameters
request
:
Request
Optional
opts
:
{
dataStrategy
?:
DataStrategyFunction
<
unknown
>
;
generateMiddlewareResponse
?:
(
queryRoute
:
(
r
:
Request
)
=>
Promise
<
Response
>
,
)
=>
MaybePromise
<
Response
>
;
requestContext
?:
unknown
;
routeId
?:
string
;
}
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