tuil
ReferencePackages@mwillbanks/tuil-routerAPI

route

function exported by @mwillbanks/tuil-router.

View rawEdit

function

Public function exported by @mwillbanks/tuil-router.

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

Members

This declaration has no public members.

Parameters

MemberTypeRequiredDescriptionRelated types
definitionRouteDefinition<TParams, TChildren>YesSupplies the definition value as RouteDefinition<TParams, TChildren>.RouteDefinition

Returns

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

Related types: RouteDefinition

Throws

No thrown errors are documented for this declaration.

Source

View the secondary source reference

Package

@mwillbanks/tuil-router

On this page