# createRouter

Source: /tuil/docs/reference/packages/router/api/create-router
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 createRouter<TRoutes extends Readonly<Record<string, object>>>(
  routes: TRoutes,
  options?: TerminalRouterOptions,
): TerminalRouter<TRoutes>;
```

## Members [#members]

This declaration has no public members.

## Parameters [#parameters]

| Member    | Type                    | Required | Description                                              | Related types                                                                          |
| --------- | ----------------------- | -------- | -------------------------------------------------------- | -------------------------------------------------------------------------------------- |
| `routes`  | `TRoutes`               | Yes      | Supplies the `routes` value as `TRoutes`.                | —                                                                                      |
| `options` | `TerminalRouterOptions` | No       | Supplies the `options` value as `TerminalRouterOptions`. | [`TerminalRouterOptions`](/tuil/docs/reference/packages/router/api/terminal-router-options) |

## Returns [#returns]

`TerminalRouter<TRoutes>` — Returns a value that satisfies `TerminalRouter<TRoutes>`.

Related types: [`TerminalRouter`](/tuil/docs/reference/packages/router/api/terminal-router)

## Throws [#throws]

No thrown errors are documented for this declaration.

## Related types [#related-types]

* [`TerminalRouter`](/tuil/docs/reference/packages/router/api/terminal-router)
* [`TerminalRouterOptions`](/tuil/docs/reference/packages/router/api/terminal-router-options)

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