NavigationOptions
What a navigation query asks for, relative to its anchor.
Properties
Section titled “Properties”fresh?
Section titled “fresh?”
optionalfresh?:boolean
Bypasses the in-memory cache for this call.
include?
Section titled “include?”
optionalinclude?: readonlyNavigationInclude[]
Defaults to the whole subtree (['self', 'descendants'], the server’s own default).
location?
Section titled “location?”
optionallocation?:LocationLike
The page this navigation is for, under a site with a locale addressing strategy. It supplies the
host a localeHost site needs for a path anchor, and the locale a node-id (or absent) anchor is
asked in. Defaults to the browser’s own location, so a browser never needs it; a server must pass
the request’s URL, since the SDK never reads a forwarded host (which proxy header can be trusted
is a fact about your deployment). Ignored for an invariant site.
maxDepth?
Section titled “maxDepth?”
optionalmaxDepth?:number
Bounds descendants by absolute depth from the site root.
signal?
Section titled “signal?”
optionalsignal?:AbortSignal