createRouter
function exported by @mwillbanks/tuil-router.
function
Public function exported by @mwillbanks/tuil-router.
export function createRouter<TRoutes extends Readonly<Record<string, object>>>(
routes: TRoutes,
options?: TerminalRouterOptions,
): TerminalRouter<TRoutes>;Members
This declaration has no public members.
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 |
Returns
TerminalRouter<TRoutes> — Returns a value that satisfies TerminalRouter<TRoutes>.
Related types: TerminalRouter
Throws
No thrown errors are documented for this declaration.
Related types
Source
View the secondary source reference