Interface State<S>

Interface describing the shape of a State of the Router. States correspond to the History, as each navigation results in a new State being created. Each Router.navigated State is represented by its absolute path its search parameters and a segment as entrypoint to the graph-like representation of the Router.navigated path through the route-tree.

interface State<S> {
    path: S;
    search: string;
    segment: Segment<S>;
}

Type Parameters

  • S extends string = string

    The Route path string type.

Properties

Properties

path: S

Absolute path of the State.

search: string

search parameters of the State.

segment: Segment<S>

Segment of the State.

Generated using TypeDoc