Interface Context<TRoute>

Route match context.

This is passed to route matcher to indicate the position inside the route the match should be searched at.

Type Parameters

  • TRoute extends PathRoute

    A type of tested route.

Hierarchy

Properties

entry entryIndex matcherIndex nameOffset pattern route

Properties

Readonly entry

entry: TRoute["path"][0]

The first entry the matcher should match against.

Readonly entryIndex

entryIndex: number

The index of the first entry within the route path the matcher should match against.

Always less than path length.

Readonly matcherIndex

matcherIndex: number

The index of the matcher in the route pattern.

Readonly nameOffset

nameOffset: number

An offset of the first character within first entry name the matcher should match against.

Readonly pattern

pattern: RoutePattern<TRoute>

The route pattern the matcher belongs to.

Readonly route

route: TRoute

Target route.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc