Interface Match<TRoute>

Route match.

This is returned from route matcher and indicates the matching part of the route.

Type Parameters

Hierarchy

  • Match

Properties

callback?: RouteMatch<TRoute>

A callback function reporting a capture of this match, if any.

It will be invoked by successful route match only.

entries?: number

The number of fully matching route entries.

When set, this value increases the index of the route entry to apply subsequent matchers to.

Default

0, which means the subsequent matcher will be applied to current entry.

See

nameChars

full?: boolean

Whether this is a full match of the route against the pattern.

nameChars?: number

The number of matching characters in the name of current route entry.

This value increases the offset in the name of the route entry to apply subsequent matchers to. If the resulting offset is equal or greater than the length of the name, then the next matcher will be applied to the same route entry. If that fails, the next entry will be used, while the offset will be set to zero.

Default

The length of current entry name, unless {@link entries} set to non-zero value, in which case
it defaults to zero.

Generated using TypeDoc