Functions: createExternalRoute()

Call Signature

function createExternalRoute<THost, TName, TPath, TQuery, THash, TMeta>(options): Route<ToName<TName>, ToWithParams<THost>, ToWithParams<TPath>, ToWithParams<TQuery>, ToWithParams<THash>, TMeta>

Type Parameters

Type Parameter	Default type
THost extends | string | WithParams<string, Record<string, undefined | Param>>	-
TName extends undefined | string	undefined
TPath extends | undefined | string | WithParams<string, Record<string, undefined | Param>>	undefined
TQuery extends | undefined | string | WithParams<string, Record<string, undefined | Param>>	undefined
THash extends | undefined | string | WithParams<string, Record<string, undefined | Param>>	undefined
TMeta extends Record<string, unknown>	Record<string, unknown>

Parameters

Parameter	Type
options	WithHooks & object & WithHost<THost> & WithoutParent

Returns

Route<ToName<TName>, ToWithParams<THost>, ToWithParams<TPath>, ToWithParams<TQuery>, ToWithParams<THash>, TMeta>

Call Signature

function createExternalRoute<TParent, TName, TPath, TQuery, THash, TMeta>(options): Route<ToName<TName>, WithParams<"", {}>, CombinePath<TParent["path"], ToWithParams<TPath>>, CombineQuery<TParent["query"], ToWithParams<TQuery>>, CombinePath<TParent["hash"], ToWithParams<THash>>, CombineMeta<TMeta, TParent["meta"]>>

Type Parameters

Type Parameter	Default type
TParent extends Route<string, WithParams<string, Record<string, undefined | Param>>, WithParams<string, Record<string, undefined | Param>>, WithParams<string, Record<string, undefined | Param>>, WithParams<string, Record<string, undefined | Param>>, Record<string, unknown>, Record<string, Param>, CreatedRouteOptions[]>	-
TName extends undefined | string	undefined
TPath extends | undefined | string | WithParams<string, Record<string, undefined | Param>>	undefined
TQuery extends | undefined | string | WithParams<string, Record<string, undefined | Param>>	undefined
THash extends | undefined | string | WithParams<string, Record<string, undefined | Param>>	undefined
TMeta extends Record<string, unknown>	Record<string, unknown>

Parameters

Parameter	Type
options	WithHooks & object & WithoutHost & WithParent<TParent>

Returns

Route<ToName<TName>, WithParams<"", {}>, CombinePath<TParent["path"], ToWithParams<TPath>>, CombineQuery<TParent["query"], ToWithParams<TQuery>>, CombinePath<TParent["hash"], ToWithParams<THash>>, CombineMeta<TMeta, TParent["meta"]>>