# RouteMatch

Source: /tuil/docs/reference/packages/router/api/route-match
Locale: en

interface exported by @mwillbanks/tuil-router.



{/* Generated by tooling/docs/generate-reference.ts. */}

## interface [#interface]

Public interface exported by `@mwillbanks/tuil-router`.

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

## Members [#members]

| Member      | Type                                | Required | Description                                                                | Related types |
| ----------- | ----------------------------------- | -------- | -------------------------------------------------------------------------- | ------------- |
| `route`     | `string`                            | Yes      | The `route` member uses the `string` contract.                             | —             |
| `params`    | `Readonly<Record<string, unknown>>` | Yes      | The `params` member uses the `Readonly<Record<string, unknown>>` contract. | —             |
| `component` | `unknown`                           | No       | The `component` member uses the `unknown` contract.                        | —             |
| `data`      | `unknown`                           | No       | The `data` member uses the `unknown` contract.                             | —             |

## Parameters [#parameters]

This declaration has no public members.

## Returns [#returns]

This declaration does not return a value.

## Throws [#throws]

No thrown errors are documented for this declaration.

## Related types [#related-types]

No package-local related types.

## Source [#source]

[View the secondary source reference](https://github.com/mwillbanks/tuil/blob/main/packages/router/src/index.ts)

## Package [#package]

[@mwillbanks/tuil-router](/tuil/docs/reference/packages/router)