tuil
ReferencePackages@mwillbanks/tuil-routerAPI

RouteMatch

interface exported by @mwillbanks/tuil-router.

View rawEdit

interface

Public interface exported by @mwillbanks/tuil-router.

export interface RouteMatch {
  readonly route: string;
  readonly params: Readonly<Record<string, unknown>>;
  readonly component?: unknown;
  readonly data?: unknown;
}

Members

MemberTypeRequiredDescriptionRelated types
routestringYesThe route member uses the string contract.
paramsReadonly<Record<string, unknown>>YesThe params member uses the Readonly<Record<string, unknown>> contract.
componentunknownNoThe component member uses the unknown contract.
dataunknownNoThe data member uses the unknown contract.

Parameters

This declaration has no public members.

Returns

This declaration does not return a value.

Throws

No thrown errors are documented for this declaration.

No package-local related types.

Source

View the secondary source reference

Package

@mwillbanks/tuil-router

On this page