Interface RouteChildrenContext<R, C>

Represents the context that is accessible from the route children callback. It is the a RouteContext without the 'next' property.

interface RouteChildrenContext<R, C> {
    chain?: RouteContext<ActionValue, RouteExtension<R, C>, ContextExtension<R, C>>["chain"];
    hash?: RouteContext<ActionValue, RouteExtension<R, C>, ContextExtension<R, C>>["hash"];
    params: RouteContext<ActionValue, RouteExtension<R, C>, ContextExtension<R, C>>["params"];
    pathname: RouteContext<ActionValue, RouteExtension<R, C>, ContextExtension<R, C>>["pathname"];
    redirectFrom?: RouteContext<ActionValue, RouteExtension<R, C>, ContextExtension<R, C>>["redirectFrom"];
    resolver?: RouteContext<ActionValue, RouteExtension<R, C>, ContextExtension<R, C>>["resolver"];
    result?: RouteContext<ActionValue, RouteExtension<R, C>, ContextExtension<R, C>>["result"];
    route: RouteContext<ActionValue, RouteExtension<R, C>, ContextExtension<R, C>>["route"];
    search?: RouteContext<ActionValue, RouteExtension<R, C>, ContextExtension<R, C>>["search"];
}

Type Parameters

  • R extends object = EmptyObject

    The type of the route parameters.

  • C extends object = EmptyObject

    The type of the route's resolved data. Defaults to EmptyObject.

Properties

chain? hash? params pathname redirectFrom? resolver? result? route search?

Properties

Optional Readonlychain

chain?: RouteContext<ActionValue, RouteExtension<R, C>, ContextExtension<R, C>>["chain"]

The sequence of the resolved route items, so said the path from the root route to the current route.

Optional Readonlyhash

hash?: RouteContext<ActionValue, RouteExtension<R, C>, ContextExtension<R, C>>["hash"]

The hash fragment of the URL.

Readonlyparams

params: RouteContext<ActionValue, RouteExtension<R, C>, ContextExtension<R, C>>["params"]

The parameters resolved from the current URL.

Readonlypathname

pathname: RouteContext<ActionValue, RouteExtension<R, C>, ContextExtension<R, C>>["pathname"]

The current location.

Optional ReadonlyredirectFrom

redirectFrom?: RouteContext<ActionValue, RouteExtension<R, C>, ContextExtension<R, C>>["redirectFrom"]

The URL from which a redirect occurred.

Optional Readonlyresolver

resolver?: RouteContext<ActionValue, RouteExtension<R, C>, ContextExtension<R, C>>["resolver"]

The resolver instance.

Optionalresult

result?: RouteContext<ActionValue, RouteExtension<R, C>, ContextExtension<R, C>>["result"]

The result of the route resolution. It could be either a value produced by the Route.action or a new context to continue the resolution process.

Readonlyroute

route: RouteContext<ActionValue, RouteExtension<R, C>, ContextExtension<R, C>>["route"]

The current route.

Optional Readonlysearch

search?: RouteContext<ActionValue, RouteExtension<R, C>, ContextExtension<R, C>>["search"]

The search query string of the URL.

Settings

Member Visibility

On This Page

Properties