# route

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

function exported by @mwillbanks/tuil-router.



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

## function [#function]

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

```ts
export function route<
  TParams = EmptyParams,
  TChildren extends Readonly<Record<string, object>> = Readonly<
    Record<string, object>
  >,
>(
  definition: RouteDefinition<TParams, TChildren>,
): RouteDefinition<TParams, TChildren>;
```

## Members [#members]

This declaration has no public members.

## Parameters [#parameters]

| Member       | Type                                  | Required | Description                                                               | Related types                                                             |
| ------------ | ------------------------------------- | -------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
| `definition` | `RouteDefinition<TParams, TChildren>` | Yes      | Supplies the `definition` value as `RouteDefinition<TParams, TChildren>`. | [`RouteDefinition`](/tuil/docs/reference/packages/router/api/route-definition) |

## Returns [#returns]

`RouteDefinition<TParams, TChildren>` — Returns a value that satisfies `RouteDefinition<TParams, TChildren>`.

Related types: [`RouteDefinition`](/tuil/docs/reference/packages/router/api/route-definition)

## Throws [#throws]

No thrown errors are documented for this declaration.

## Related types [#related-types]

* [`RouteDefinition`](/tuil/docs/reference/packages/router/api/route-definition)

## 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)